@mistralai/mistralai 1.10.0 → 1.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -7
- package/funcs/audioTranscriptionsStream.d.ts +1 -1
- package/funcs/audioTranscriptionsStream.js +1 -1
- package/funcs/betaAgentsDelete.d.ts +15 -0
- package/funcs/betaAgentsDelete.d.ts.map +1 -0
- package/funcs/betaAgentsDelete.js +121 -0
- package/funcs/betaAgentsDelete.js.map +1 -0
- package/funcs/betaAgentsGet.js +4 -0
- package/funcs/betaAgentsGet.js.map +1 -1
- package/funcs/betaAgentsList.js +5 -0
- package/funcs/betaAgentsList.js.map +1 -1
- package/funcs/betaConversationsDelete.d.ts +18 -0
- package/funcs/betaConversationsDelete.d.ts.map +1 -0
- package/funcs/betaConversationsDelete.js +124 -0
- package/funcs/betaConversationsDelete.js.map +1 -0
- package/funcs/betaConversationsList.js +1 -0
- package/funcs/betaConversationsList.js.map +1 -1
- package/funcs/betaLibrariesDocumentsList.d.ts +1 -1
- package/funcs/betaLibrariesDocumentsList.js +2 -1
- package/funcs/betaLibrariesDocumentsList.js.map +1 -1
- package/funcs/filesList.js +1 -0
- package/funcs/filesList.js.map +1 -1
- package/funcs/modelsList.d.ts +1 -2
- package/funcs/modelsList.d.ts.map +1 -1
- package/funcs/modelsList.js +2 -6
- package/funcs/modelsList.js.map +1 -1
- package/jsr.json +1 -1
- package/lib/config.d.ts +2 -2
- package/lib/config.js +2 -2
- package/models/components/agent.d.ts +12 -0
- package/models/components/agent.d.ts.map +1 -1
- package/models/components/agent.js +10 -0
- package/models/components/agent.js.map +1 -1
- package/models/components/agentconversation.d.ts +11 -0
- package/models/components/agentconversation.d.ts.map +1 -1
- package/models/components/agentconversation.js +6 -0
- package/models/components/agentconversation.js.map +1 -1
- package/models/components/agentcreationrequest.d.ts +6 -0
- package/models/components/agentcreationrequest.d.ts.map +1 -1
- package/models/components/agentcreationrequest.js +2 -0
- package/models/components/agentcreationrequest.js.map +1 -1
- package/models/components/agentscompletionrequest.d.ts +14 -2
- package/models/components/agentscompletionrequest.d.ts.map +1 -1
- package/models/components/agentscompletionrequest.js +2 -0
- package/models/components/agentscompletionrequest.js.map +1 -1
- package/models/components/agentscompletionstreamrequest.d.ts +14 -2
- package/models/components/agentscompletionstreamrequest.d.ts.map +1 -1
- package/models/components/agentscompletionstreamrequest.js +2 -0
- package/models/components/agentscompletionstreamrequest.js.map +1 -1
- package/models/components/agentupdaterequest.d.ts +8 -0
- package/models/components/agentupdaterequest.d.ts.map +1 -1
- package/models/components/agentupdaterequest.js +6 -0
- package/models/components/agentupdaterequest.js.map +1 -1
- package/models/components/audiotranscriptionrequest.d.ts +3 -0
- package/models/components/audiotranscriptionrequest.d.ts.map +1 -1
- package/models/components/audiotranscriptionrequest.js.map +1 -1
- package/models/components/batchjobin.d.ts +15 -0
- package/models/components/batchjobin.d.ts.map +1 -1
- package/models/components/batchjobin.js.map +1 -1
- package/models/components/chatcompletionrequest.d.ts +26 -2
- package/models/components/chatcompletionrequest.d.ts.map +1 -1
- package/models/components/chatcompletionrequest.js +2 -0
- package/models/components/chatcompletionrequest.js.map +1 -1
- package/models/components/chatcompletionstreamrequest.d.ts +26 -2
- package/models/components/chatcompletionstreamrequest.d.ts.map +1 -1
- package/models/components/chatcompletionstreamrequest.js +2 -0
- package/models/components/chatcompletionstreamrequest.js.map +1 -1
- package/models/components/conversationrequest.d.ts +13 -2
- package/models/components/conversationrequest.d.ts.map +1 -1
- package/models/components/conversationrequest.js +16 -6
- package/models/components/conversationrequest.js.map +1 -1
- package/models/components/conversationrestartrequest.d.ts +14 -0
- package/models/components/conversationrestartrequest.d.ts.map +1 -1
- package/models/components/conversationrestartrequest.js +6 -0
- package/models/components/conversationrestartrequest.js.map +1 -1
- package/models/components/conversationrestartstreamrequest.d.ts +14 -0
- package/models/components/conversationrestartstreamrequest.d.ts.map +1 -1
- package/models/components/conversationrestartstreamrequest.js +6 -0
- package/models/components/conversationrestartstreamrequest.js.map +1 -1
- package/models/components/conversationstreamrequest.d.ts +13 -2
- package/models/components/conversationstreamrequest.d.ts.map +1 -1
- package/models/components/conversationstreamrequest.js +16 -6
- package/models/components/conversationstreamrequest.js.map +1 -1
- package/models/components/documentout.d.ts +18 -10
- package/models/components/documentout.d.ts.map +1 -1
- package/models/components/documentout.js +14 -10
- package/models/components/documentout.js.map +1 -1
- package/models/components/documentupdatein.d.ts +27 -0
- package/models/components/documentupdatein.d.ts.map +1 -1
- package/models/components/documentupdatein.js +66 -1
- package/models/components/documentupdatein.js.map +1 -1
- package/models/components/embeddingrequest.d.ts +4 -4
- package/models/components/fimcompletionrequest.d.ts +7 -5
- package/models/components/fimcompletionrequest.d.ts.map +1 -1
- package/models/components/fimcompletionrequest.js +2 -0
- package/models/components/fimcompletionrequest.js.map +1 -1
- package/models/components/fimcompletionstreamrequest.d.ts +7 -5
- package/models/components/fimcompletionstreamrequest.d.ts.map +1 -1
- package/models/components/fimcompletionstreamrequest.js +2 -0
- package/models/components/fimcompletionstreamrequest.js.map +1 -1
- package/models/components/index.d.ts +2 -0
- package/models/components/index.d.ts.map +1 -1
- package/models/components/index.js +2 -0
- package/models/components/index.js.map +1 -1
- package/models/components/libraryout.d.ts +7 -4
- package/models/components/libraryout.d.ts.map +1 -1
- package/models/components/libraryout.js +6 -6
- package/models/components/libraryout.js.map +1 -1
- package/models/components/listfilesout.d.ts +2 -2
- package/models/components/listfilesout.d.ts.map +1 -1
- package/models/components/listfilesout.js +2 -2
- package/models/components/listfilesout.js.map +1 -1
- package/models/components/modelcapabilities.d.ts +8 -2
- package/models/components/modelcapabilities.d.ts.map +1 -1
- package/models/components/modelcapabilities.js +12 -6
- package/models/components/modelcapabilities.js.map +1 -1
- package/models/components/modelconversation.d.ts +9 -0
- package/models/components/modelconversation.d.ts.map +1 -1
- package/models/components/modelconversation.js +2 -0
- package/models/components/modelconversation.js.map +1 -1
- package/models/components/ocrpageobject.d.ts +21 -0
- package/models/components/ocrpageobject.d.ts.map +1 -1
- package/models/components/ocrpageobject.js +9 -0
- package/models/components/ocrpageobject.js.map +1 -1
- package/models/components/ocrrequest.d.ts +32 -0
- package/models/components/ocrrequest.d.ts.map +1 -1
- package/models/components/ocrrequest.js +33 -1
- package/models/components/ocrrequest.js.map +1 -1
- package/models/components/ocrtableobject.d.ts +74 -0
- package/models/components/ocrtableobject.d.ts.map +1 -0
- package/models/components/ocrtableobject.js +96 -0
- package/models/components/ocrtableobject.js.map +1 -0
- package/models/components/prediction.d.ts +3 -0
- package/models/components/prediction.d.ts.map +1 -1
- package/models/components/prediction.js.map +1 -1
- package/models/components/requestsource.d.ts +31 -0
- package/models/components/requestsource.d.ts.map +1 -0
- package/models/components/requestsource.js +61 -0
- package/models/components/requestsource.js.map +1 -0
- package/models/components/responseformat.d.ts +3 -3
- package/models/components/responseformat.d.ts.map +1 -1
- package/models/components/responseformats.d.ts +0 -6
- package/models/components/responseformats.d.ts.map +1 -1
- package/models/components/responseformats.js +0 -3
- package/models/components/responseformats.js.map +1 -1
- package/models/components/sharingdelete.d.ts +2 -2
- package/models/components/sharingdelete.d.ts.map +1 -1
- package/models/components/sharingdelete.js +2 -2
- package/models/components/sharingdelete.js.map +1 -1
- package/models/components/sharingin.d.ts +2 -2
- package/models/components/sharingin.d.ts.map +1 -1
- package/models/components/sharingin.js +2 -2
- package/models/components/sharingin.js.map +1 -1
- package/models/components/sharingout.d.ts +2 -2
- package/models/components/sharingout.d.ts.map +1 -1
- package/models/components/sharingout.js +2 -2
- package/models/components/sharingout.js.map +1 -1
- package/models/components/toolexecutiondeltaevent.d.ts +23 -2
- package/models/components/toolexecutiondeltaevent.d.ts.map +1 -1
- package/models/components/toolexecutiondeltaevent.js +26 -3
- package/models/components/toolexecutiondeltaevent.js.map +1 -1
- package/models/components/toolexecutiondoneevent.d.ts +23 -2
- package/models/components/toolexecutiondoneevent.d.ts.map +1 -1
- package/models/components/toolexecutiondoneevent.js +26 -3
- package/models/components/toolexecutiondoneevent.js.map +1 -1
- package/models/components/toolexecutionentry.d.ts +23 -2
- package/models/components/toolexecutionentry.d.ts.map +1 -1
- package/models/components/toolexecutionentry.js +27 -3
- package/models/components/toolexecutionentry.js.map +1 -1
- package/models/components/toolexecutionstartedevent.d.ts +23 -2
- package/models/components/toolexecutionstartedevent.d.ts.map +1 -1
- package/models/components/toolexecutionstartedevent.js +26 -3
- package/models/components/toolexecutionstartedevent.js.map +1 -1
- package/models/operations/agentsapiv1agentsdelete.d.ts +29 -0
- package/models/operations/agentsapiv1agentsdelete.d.ts.map +1 -0
- package/models/operations/agentsapiv1agentsdelete.js +78 -0
- package/models/operations/agentsapiv1agentsdelete.js.map +1 -0
- package/models/operations/agentsapiv1agentsget.d.ts +2 -0
- package/models/operations/agentsapiv1agentsget.d.ts.map +1 -1
- package/models/operations/agentsapiv1agentsget.js +4 -0
- package/models/operations/agentsapiv1agentsget.js.map +1 -1
- package/models/operations/agentsapiv1agentslist.d.ts +15 -0
- package/models/operations/agentsapiv1agentslist.d.ts.map +1 -1
- package/models/operations/agentsapiv1agentslist.js +15 -0
- package/models/operations/agentsapiv1agentslist.js.map +1 -1
- package/models/operations/agentsapiv1conversationsdelete.d.ts +32 -0
- package/models/operations/agentsapiv1conversationsdelete.d.ts.map +1 -0
- package/models/operations/agentsapiv1conversationsdelete.js +78 -0
- package/models/operations/agentsapiv1conversationsdelete.js.map +1 -0
- package/models/operations/agentsapiv1conversationslist.d.ts +6 -0
- package/models/operations/agentsapiv1conversationslist.d.ts.map +1 -1
- package/models/operations/agentsapiv1conversationslist.js +2 -0
- package/models/operations/agentsapiv1conversationslist.js.map +1 -1
- package/models/operations/filesapirouteslistfiles.d.ts +2 -0
- package/models/operations/filesapirouteslistfiles.d.ts.map +1 -1
- package/models/operations/filesapirouteslistfiles.js +4 -0
- package/models/operations/filesapirouteslistfiles.js.map +1 -1
- package/models/operations/index.d.ts +2 -0
- package/models/operations/index.d.ts.map +1 -1
- package/models/operations/index.js +2 -0
- package/models/operations/index.js.map +1 -1
- package/models/operations/librariesdocumentslistv1.d.ts +2 -0
- package/models/operations/librariesdocumentslistv1.d.ts.map +1 -1
- package/models/operations/librariesdocumentslistv1.js +4 -0
- package/models/operations/librariesdocumentslistv1.js.map +1 -1
- package/package.json +1 -1
- package/sdk/conversations.d.ts +7 -0
- package/sdk/conversations.d.ts.map +1 -1
- package/sdk/conversations.js +10 -0
- package/sdk/conversations.js.map +1 -1
- package/sdk/documents.d.ts +1 -1
- package/sdk/documents.js +1 -1
- package/sdk/mistralagents.d.ts +4 -0
- package/sdk/mistralagents.d.ts.map +1 -1
- package/sdk/mistralagents.js +7 -0
- package/sdk/mistralagents.js.map +1 -1
- package/sdk/transcriptions.d.ts +1 -1
- package/sdk/transcriptions.js +1 -1
- package/src/funcs/audioTranscriptionsStream.ts +1 -1
- package/src/funcs/betaAgentsDelete.ts +174 -0
- package/src/funcs/betaAgentsGet.ts +6 -1
- package/src/funcs/betaAgentsList.ts +5 -0
- package/src/funcs/betaConversationsDelete.ts +179 -0
- package/src/funcs/betaConversationsList.ts +1 -0
- package/src/funcs/betaLibrariesDocumentsList.ts +2 -1
- package/src/funcs/filesList.ts +1 -0
- package/src/funcs/modelsList.ts +2 -11
- package/src/lib/config.ts +2 -2
- package/src/models/components/agent.ts +18 -0
- package/src/models/components/agentconversation.ts +13 -0
- package/src/models/components/agentcreationrequest.ts +4 -0
- package/src/models/components/agentscompletionrequest.ts +12 -2
- package/src/models/components/agentscompletionstreamrequest.ts +12 -2
- package/src/models/components/agentupdaterequest.ts +10 -0
- package/src/models/components/audiotranscriptionrequest.ts +3 -0
- package/src/models/components/batchjobin.ts +15 -0
- package/src/models/components/chatcompletionrequest.ts +24 -2
- package/src/models/components/chatcompletionstreamrequest.ts +24 -2
- package/src/models/components/conversationrequest.ts +79 -72
- package/src/models/components/conversationrestartrequest.ts +16 -0
- package/src/models/components/conversationrestartstreamrequest.ts +16 -0
- package/src/models/components/conversationstreamrequest.ts +79 -72
- package/src/models/components/documentout.ts +28 -20
- package/src/models/components/documentupdatein.ts +144 -0
- package/src/models/components/embeddingrequest.ts +4 -4
- package/src/models/components/fimcompletionrequest.ts +5 -5
- package/src/models/components/fimcompletionstreamrequest.ts +5 -5
- package/src/models/components/index.ts +2 -0
- package/src/models/components/libraryout.ts +13 -10
- package/src/models/components/listfilesout.ts +4 -4
- package/src/models/components/modelcapabilities.ts +20 -8
- package/src/models/components/modelconversation.ts +7 -0
- package/src/models/components/ocrpageobject.ts +34 -0
- package/src/models/components/ocrrequest.ts +44 -0
- package/src/models/components/ocrtableobject.ts +111 -0
- package/src/models/components/prediction.ts +3 -0
- package/src/models/components/requestsource.ts +34 -0
- package/src/models/components/responseformat.ts +3 -3
- package/src/models/components/responseformats.ts +0 -6
- package/src/models/components/sharingdelete.ts +4 -4
- package/src/models/components/sharingin.ts +4 -4
- package/src/models/components/sharingout.ts +4 -4
- package/src/models/components/toolexecutiondeltaevent.ts +56 -4
- package/src/models/components/toolexecutiondoneevent.ts +54 -4
- package/src/models/components/toolexecutionentry.ts +44 -4
- package/src/models/components/toolexecutionstartedevent.ts +56 -4
- package/src/models/operations/agentsapiv1agentsdelete.ts +77 -0
- package/src/models/operations/agentsapiv1agentsget.ts +6 -0
- package/src/models/operations/agentsapiv1agentslist.ts +25 -0
- package/src/models/operations/agentsapiv1conversationsdelete.ts +83 -0
- package/src/models/operations/agentsapiv1conversationslist.ts +4 -0
- package/src/models/operations/filesapirouteslistfiles.ts +6 -0
- package/src/models/operations/index.ts +2 -0
- package/src/models/operations/librariesdocumentslistv1.ts +6 -0
- package/src/sdk/conversations.ts +18 -0
- package/src/sdk/documents.ts +1 -1
- package/src/sdk/mistralagents.ts +15 -0
- package/src/sdk/transcriptions.ts +1 -1
- package/.devcontainer/README.md +0 -35
- package/docs/sdks/accesses/README.md +0 -256
- package/docs/sdks/agents/README.md +0 -189
- package/docs/sdks/audio/README.md +0 -6
- package/docs/sdks/batch/README.md +0 -6
- package/docs/sdks/beta/README.md +0 -6
- package/docs/sdks/chat/README.md +0 -189
- package/docs/sdks/classifiers/README.md +0 -355
- package/docs/sdks/conversations/README.md +0 -835
- package/docs/sdks/documents/README.md +0 -785
- package/docs/sdks/embeddings/README.md +0 -92
- package/docs/sdks/files/README.md +0 -455
- package/docs/sdks/fim/README.md +0 -173
- package/docs/sdks/finetuning/README.md +0 -6
- package/docs/sdks/jobs/README.md +0 -379
- package/docs/sdks/libraries/README.md +0 -380
- package/docs/sdks/mistral/README.md +0 -7
- package/docs/sdks/mistralagents/README.md +0 -386
- package/docs/sdks/mistraljobs/README.md +0 -305
- package/docs/sdks/models/README.md +0 -453
- package/docs/sdks/ocr/README.md +0 -92
- package/docs/sdks/transcriptions/README.md +0 -163
- package/examples/README.md +0 -44
- package/packages/mistralai-azure/FUNCTIONS.md +0 -111
- package/packages/mistralai-azure/LICENSE +0 -201
- package/packages/mistralai-azure/README.md +0 -447
- package/packages/mistralai-azure/RUNTIMES.md +0 -48
- package/packages/mistralai-azure/docs/sdks/chat/README.md +0 -114
- package/packages/mistralai-azure/docs/sdks/mistralazure/README.md +0 -9
- package/packages/mistralai-gcp/FUNCTIONS.md +0 -112
- package/packages/mistralai-gcp/LICENSE +0 -201
- package/packages/mistralai-gcp/README.md +0 -455
- package/packages/mistralai-gcp/RUNTIMES.md +0 -48
- package/packages/mistralai-gcp/docs/sdks/chat/README.md +0 -115
- package/packages/mistralai-gcp/docs/sdks/fim/README.md +0 -58
- package/packages/mistralai-gcp/docs/sdks/mistralgcp/README.md +0 -9
- package/src/extra/README.md +0 -52
|
@@ -90,11 +90,15 @@ export type Agent = {
|
|
|
90
90
|
name: string;
|
|
91
91
|
description?: string | null | undefined;
|
|
92
92
|
handoffs?: Array<string> | null | undefined;
|
|
93
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
93
94
|
object?: AgentObject | undefined;
|
|
94
95
|
id: string;
|
|
95
96
|
version: number;
|
|
97
|
+
versions: Array<number>;
|
|
96
98
|
createdAt: Date;
|
|
97
99
|
updatedAt: Date;
|
|
100
|
+
deploymentChat: boolean;
|
|
101
|
+
source: string;
|
|
98
102
|
};
|
|
99
103
|
|
|
100
104
|
/** @internal */
|
|
@@ -271,20 +275,25 @@ export const Agent$inboundSchema: z.ZodType<Agent, z.ZodTypeDef, unknown> = z
|
|
|
271
275
|
name: z.string(),
|
|
272
276
|
description: z.nullable(z.string()).optional(),
|
|
273
277
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
278
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
274
279
|
object: AgentObject$inboundSchema.default("agent"),
|
|
275
280
|
id: z.string(),
|
|
276
281
|
version: z.number().int(),
|
|
282
|
+
versions: z.array(z.number().int()),
|
|
277
283
|
created_at: z.string().datetime({ offset: true }).transform(v =>
|
|
278
284
|
new Date(v)
|
|
279
285
|
),
|
|
280
286
|
updated_at: z.string().datetime({ offset: true }).transform(v =>
|
|
281
287
|
new Date(v)
|
|
282
288
|
),
|
|
289
|
+
deployment_chat: z.boolean(),
|
|
290
|
+
source: z.string(),
|
|
283
291
|
}).transform((v) => {
|
|
284
292
|
return remap$(v, {
|
|
285
293
|
"completion_args": "completionArgs",
|
|
286
294
|
"created_at": "createdAt",
|
|
287
295
|
"updated_at": "updatedAt",
|
|
296
|
+
"deployment_chat": "deploymentChat",
|
|
288
297
|
});
|
|
289
298
|
});
|
|
290
299
|
|
|
@@ -306,11 +315,15 @@ export type Agent$Outbound = {
|
|
|
306
315
|
name: string;
|
|
307
316
|
description?: string | null | undefined;
|
|
308
317
|
handoffs?: Array<string> | null | undefined;
|
|
318
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
309
319
|
object: string;
|
|
310
320
|
id: string;
|
|
311
321
|
version: number;
|
|
322
|
+
versions: Array<number>;
|
|
312
323
|
created_at: string;
|
|
313
324
|
updated_at: string;
|
|
325
|
+
deployment_chat: boolean;
|
|
326
|
+
source: string;
|
|
314
327
|
};
|
|
315
328
|
|
|
316
329
|
/** @internal */
|
|
@@ -359,16 +372,21 @@ export const Agent$outboundSchema: z.ZodType<
|
|
|
359
372
|
name: z.string(),
|
|
360
373
|
description: z.nullable(z.string()).optional(),
|
|
361
374
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
375
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
362
376
|
object: AgentObject$outboundSchema.default("agent"),
|
|
363
377
|
id: z.string(),
|
|
364
378
|
version: z.number().int(),
|
|
379
|
+
versions: z.array(z.number().int()),
|
|
365
380
|
createdAt: z.date().transform(v => v.toISOString()),
|
|
366
381
|
updatedAt: z.date().transform(v => v.toISOString()),
|
|
382
|
+
deploymentChat: z.boolean(),
|
|
383
|
+
source: z.string(),
|
|
367
384
|
}).transform((v) => {
|
|
368
385
|
return remap$(v, {
|
|
369
386
|
completionArgs: "completion_args",
|
|
370
387
|
createdAt: "created_at",
|
|
371
388
|
updatedAt: "updated_at",
|
|
389
|
+
deploymentChat: "deployment_chat",
|
|
372
390
|
});
|
|
373
391
|
});
|
|
374
392
|
|
|
@@ -25,11 +25,16 @@ export type AgentConversation = {
|
|
|
25
25
|
* Description of the what the conversation is about.
|
|
26
26
|
*/
|
|
27
27
|
description?: string | null | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* Custom metadata for the conversation.
|
|
30
|
+
*/
|
|
31
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
28
32
|
object?: AgentConversationObject | undefined;
|
|
29
33
|
id: string;
|
|
30
34
|
createdAt: Date;
|
|
31
35
|
updatedAt: Date;
|
|
32
36
|
agentId: string;
|
|
37
|
+
agentVersion?: number | null | undefined;
|
|
33
38
|
};
|
|
34
39
|
|
|
35
40
|
/** @internal */
|
|
@@ -61,16 +66,19 @@ export const AgentConversation$inboundSchema: z.ZodType<
|
|
|
61
66
|
> = z.object({
|
|
62
67
|
name: z.nullable(z.string()).optional(),
|
|
63
68
|
description: z.nullable(z.string()).optional(),
|
|
69
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
64
70
|
object: AgentConversationObject$inboundSchema.default("conversation"),
|
|
65
71
|
id: z.string(),
|
|
66
72
|
created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
|
|
67
73
|
updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
|
|
68
74
|
agent_id: z.string(),
|
|
75
|
+
agent_version: z.nullable(z.number().int()).optional(),
|
|
69
76
|
}).transform((v) => {
|
|
70
77
|
return remap$(v, {
|
|
71
78
|
"created_at": "createdAt",
|
|
72
79
|
"updated_at": "updatedAt",
|
|
73
80
|
"agent_id": "agentId",
|
|
81
|
+
"agent_version": "agentVersion",
|
|
74
82
|
});
|
|
75
83
|
});
|
|
76
84
|
|
|
@@ -78,11 +86,13 @@ export const AgentConversation$inboundSchema: z.ZodType<
|
|
|
78
86
|
export type AgentConversation$Outbound = {
|
|
79
87
|
name?: string | null | undefined;
|
|
80
88
|
description?: string | null | undefined;
|
|
89
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
81
90
|
object: string;
|
|
82
91
|
id: string;
|
|
83
92
|
created_at: string;
|
|
84
93
|
updated_at: string;
|
|
85
94
|
agent_id: string;
|
|
95
|
+
agent_version?: number | null | undefined;
|
|
86
96
|
};
|
|
87
97
|
|
|
88
98
|
/** @internal */
|
|
@@ -93,16 +103,19 @@ export const AgentConversation$outboundSchema: z.ZodType<
|
|
|
93
103
|
> = z.object({
|
|
94
104
|
name: z.nullable(z.string()).optional(),
|
|
95
105
|
description: z.nullable(z.string()).optional(),
|
|
106
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
96
107
|
object: AgentConversationObject$outboundSchema.default("conversation"),
|
|
97
108
|
id: z.string(),
|
|
98
109
|
createdAt: z.date().transform(v => v.toISOString()),
|
|
99
110
|
updatedAt: z.date().transform(v => v.toISOString()),
|
|
100
111
|
agentId: z.string(),
|
|
112
|
+
agentVersion: z.nullable(z.number().int()).optional(),
|
|
101
113
|
}).transform((v) => {
|
|
102
114
|
return remap$(v, {
|
|
103
115
|
createdAt: "created_at",
|
|
104
116
|
updatedAt: "updated_at",
|
|
105
117
|
agentId: "agent_id",
|
|
118
|
+
agentVersion: "agent_version",
|
|
106
119
|
});
|
|
107
120
|
});
|
|
108
121
|
|
|
@@ -84,6 +84,7 @@ export type AgentCreationRequest = {
|
|
|
84
84
|
name: string;
|
|
85
85
|
description?: string | null | undefined;
|
|
86
86
|
handoffs?: Array<string> | null | undefined;
|
|
87
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
87
88
|
};
|
|
88
89
|
|
|
89
90
|
/** @internal */
|
|
@@ -248,6 +249,7 @@ export const AgentCreationRequest$inboundSchema: z.ZodType<
|
|
|
248
249
|
name: z.string(),
|
|
249
250
|
description: z.nullable(z.string()).optional(),
|
|
250
251
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
252
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
251
253
|
}).transform((v) => {
|
|
252
254
|
return remap$(v, {
|
|
253
255
|
"completion_args": "completionArgs",
|
|
@@ -272,6 +274,7 @@ export type AgentCreationRequest$Outbound = {
|
|
|
272
274
|
name: string;
|
|
273
275
|
description?: string | null | undefined;
|
|
274
276
|
handoffs?: Array<string> | null | undefined;
|
|
277
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
275
278
|
};
|
|
276
279
|
|
|
277
280
|
/** @internal */
|
|
@@ -320,6 +323,7 @@ export const AgentCreationRequest$outboundSchema: z.ZodType<
|
|
|
320
323
|
name: z.string(),
|
|
321
324
|
description: z.nullable(z.string()).optional(),
|
|
322
325
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
326
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
323
327
|
}).transform((v) => {
|
|
324
328
|
return remap$(v, {
|
|
325
329
|
completionArgs: "completion_args",
|
|
@@ -96,6 +96,7 @@ export type AgentsCompletionRequest = {
|
|
|
96
96
|
* The seed to use for random sampling. If set, different calls will generate deterministic results.
|
|
97
97
|
*/
|
|
98
98
|
randomSeed?: number | null | undefined;
|
|
99
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
99
100
|
/**
|
|
100
101
|
* The prompt(s) to generate completions for, encoded as a list of dict with role and content.
|
|
101
102
|
*/
|
|
@@ -105,21 +106,27 @@ export type AgentsCompletionRequest = {
|
|
|
105
106
|
| (UserMessage & { role: "user" })
|
|
106
107
|
| (AssistantMessage & { role: "assistant" })
|
|
107
108
|
>;
|
|
109
|
+
/**
|
|
110
|
+
* Specify the format that the model must output. By default it will use `{ "type": "text" }`. 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. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
|
|
111
|
+
*/
|
|
108
112
|
responseFormat?: ResponseFormat | undefined;
|
|
109
113
|
tools?: Array<Tool> | null | undefined;
|
|
110
114
|
toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
|
|
111
115
|
/**
|
|
112
|
-
* 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.
|
|
116
|
+
* The `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.
|
|
113
117
|
*/
|
|
114
118
|
presencePenalty?: number | undefined;
|
|
115
119
|
/**
|
|
116
|
-
* 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.
|
|
120
|
+
* The `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.
|
|
117
121
|
*/
|
|
118
122
|
frequencyPenalty?: number | undefined;
|
|
119
123
|
/**
|
|
120
124
|
* Number of completions to return for each request, input tokens are only billed once.
|
|
121
125
|
*/
|
|
122
126
|
n?: number | null | undefined;
|
|
127
|
+
/**
|
|
128
|
+
* Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
|
|
129
|
+
*/
|
|
123
130
|
prediction?: Prediction | undefined;
|
|
124
131
|
parallelToolCalls?: boolean | undefined;
|
|
125
132
|
/**
|
|
@@ -333,6 +340,7 @@ export const AgentsCompletionRequest$inboundSchema: z.ZodType<
|
|
|
333
340
|
stream: z.boolean().default(false),
|
|
334
341
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
335
342
|
random_seed: z.nullable(z.number().int()).optional(),
|
|
343
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
336
344
|
messages: z.array(
|
|
337
345
|
z.union([
|
|
338
346
|
SystemMessage$inboundSchema.and(
|
|
@@ -388,6 +396,7 @@ export type AgentsCompletionRequest$Outbound = {
|
|
|
388
396
|
stream: boolean;
|
|
389
397
|
stop?: string | Array<string> | undefined;
|
|
390
398
|
random_seed?: number | null | undefined;
|
|
399
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
391
400
|
messages: Array<
|
|
392
401
|
| (SystemMessage$Outbound & { role: "system" })
|
|
393
402
|
| (ToolMessage$Outbound & { role: "tool" })
|
|
@@ -416,6 +425,7 @@ export const AgentsCompletionRequest$outboundSchema: z.ZodType<
|
|
|
416
425
|
stream: z.boolean().default(false),
|
|
417
426
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
418
427
|
randomSeed: z.nullable(z.number().int()).optional(),
|
|
428
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
419
429
|
messages: z.array(
|
|
420
430
|
z.union([
|
|
421
431
|
SystemMessage$outboundSchema.and(
|
|
@@ -95,6 +95,7 @@ export type AgentsCompletionStreamRequest = {
|
|
|
95
95
|
* The seed to use for random sampling. If set, different calls will generate deterministic results.
|
|
96
96
|
*/
|
|
97
97
|
randomSeed?: number | null | undefined;
|
|
98
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
98
99
|
/**
|
|
99
100
|
* The prompt(s) to generate completions for, encoded as a list of dict with role and content.
|
|
100
101
|
*/
|
|
@@ -104,21 +105,27 @@ export type AgentsCompletionStreamRequest = {
|
|
|
104
105
|
| (UserMessage & { role: "user" })
|
|
105
106
|
| (AssistantMessage & { role: "assistant" })
|
|
106
107
|
>;
|
|
108
|
+
/**
|
|
109
|
+
* Specify the format that the model must output. By default it will use `{ "type": "text" }`. 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. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
|
|
110
|
+
*/
|
|
107
111
|
responseFormat?: ResponseFormat | undefined;
|
|
108
112
|
tools?: Array<Tool> | null | undefined;
|
|
109
113
|
toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
|
|
110
114
|
/**
|
|
111
|
-
* 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.
|
|
115
|
+
* The `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.
|
|
112
116
|
*/
|
|
113
117
|
presencePenalty?: number | undefined;
|
|
114
118
|
/**
|
|
115
|
-
* 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.
|
|
119
|
+
* The `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.
|
|
116
120
|
*/
|
|
117
121
|
frequencyPenalty?: number | undefined;
|
|
118
122
|
/**
|
|
119
123
|
* Number of completions to return for each request, input tokens are only billed once.
|
|
120
124
|
*/
|
|
121
125
|
n?: number | null | undefined;
|
|
126
|
+
/**
|
|
127
|
+
* Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
|
|
128
|
+
*/
|
|
122
129
|
prediction?: Prediction | undefined;
|
|
123
130
|
parallelToolCalls?: boolean | undefined;
|
|
124
131
|
/**
|
|
@@ -344,6 +351,7 @@ export const AgentsCompletionStreamRequest$inboundSchema: z.ZodType<
|
|
|
344
351
|
stream: z.boolean().default(true),
|
|
345
352
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
346
353
|
random_seed: z.nullable(z.number().int()).optional(),
|
|
354
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
347
355
|
messages: z.array(
|
|
348
356
|
z.union([
|
|
349
357
|
SystemMessage$inboundSchema.and(
|
|
@@ -399,6 +407,7 @@ export type AgentsCompletionStreamRequest$Outbound = {
|
|
|
399
407
|
stream: boolean;
|
|
400
408
|
stop?: string | Array<string> | undefined;
|
|
401
409
|
random_seed?: number | null | undefined;
|
|
410
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
402
411
|
messages: Array<
|
|
403
412
|
| (SystemMessage$Outbound & { role: "system" })
|
|
404
413
|
| (ToolMessage$Outbound & { role: "tool" })
|
|
@@ -427,6 +436,7 @@ export const AgentsCompletionStreamRequest$outboundSchema: z.ZodType<
|
|
|
427
436
|
stream: z.boolean().default(true),
|
|
428
437
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
429
438
|
randomSeed: z.nullable(z.number().int()).optional(),
|
|
439
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
430
440
|
messages: z.array(
|
|
431
441
|
z.union([
|
|
432
442
|
SystemMessage$outboundSchema.and(
|
|
@@ -84,6 +84,8 @@ export type AgentUpdateRequest = {
|
|
|
84
84
|
name?: string | null | undefined;
|
|
85
85
|
description?: string | null | undefined;
|
|
86
86
|
handoffs?: Array<string> | null | undefined;
|
|
87
|
+
deploymentChat?: boolean | null | undefined;
|
|
88
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
87
89
|
};
|
|
88
90
|
|
|
89
91
|
/** @internal */
|
|
@@ -248,9 +250,12 @@ export const AgentUpdateRequest$inboundSchema: z.ZodType<
|
|
|
248
250
|
name: z.nullable(z.string()).optional(),
|
|
249
251
|
description: z.nullable(z.string()).optional(),
|
|
250
252
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
253
|
+
deployment_chat: z.nullable(z.boolean()).optional(),
|
|
254
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
251
255
|
}).transform((v) => {
|
|
252
256
|
return remap$(v, {
|
|
253
257
|
"completion_args": "completionArgs",
|
|
258
|
+
"deployment_chat": "deploymentChat",
|
|
254
259
|
});
|
|
255
260
|
});
|
|
256
261
|
|
|
@@ -272,6 +277,8 @@ export type AgentUpdateRequest$Outbound = {
|
|
|
272
277
|
name?: string | null | undefined;
|
|
273
278
|
description?: string | null | undefined;
|
|
274
279
|
handoffs?: Array<string> | null | undefined;
|
|
280
|
+
deployment_chat?: boolean | null | undefined;
|
|
281
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
275
282
|
};
|
|
276
283
|
|
|
277
284
|
/** @internal */
|
|
@@ -320,9 +327,12 @@ export const AgentUpdateRequest$outboundSchema: z.ZodType<
|
|
|
320
327
|
name: z.nullable(z.string()).optional(),
|
|
321
328
|
description: z.nullable(z.string()).optional(),
|
|
322
329
|
handoffs: z.nullable(z.array(z.string())).optional(),
|
|
330
|
+
deploymentChat: z.nullable(z.boolean()).optional(),
|
|
331
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
323
332
|
}).transform((v) => {
|
|
324
333
|
return remap$(v, {
|
|
325
334
|
completionArgs: "completion_args",
|
|
335
|
+
deploymentChat: "deployment_chat",
|
|
326
336
|
});
|
|
327
337
|
});
|
|
328
338
|
|
|
@@ -14,11 +14,26 @@ import {
|
|
|
14
14
|
} from "./apiendpoint.js";
|
|
15
15
|
|
|
16
16
|
export type BatchJobIn = {
|
|
17
|
+
/**
|
|
18
|
+
* The list of input files to be used for batch inference, these files should be `jsonl` files, containing the input data corresponding to the bory request for the batch inference in a "body" field. An example of such file is the following: ```json {"custom_id": "0", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French cheese?"}]}} {"custom_id": "1", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French wine?"}]}} ```
|
|
19
|
+
*/
|
|
17
20
|
inputFiles: Array<string>;
|
|
18
21
|
endpoint: ApiEndpoint;
|
|
22
|
+
/**
|
|
23
|
+
* The model to be used for batch inference.
|
|
24
|
+
*/
|
|
19
25
|
model?: string | null | undefined;
|
|
26
|
+
/**
|
|
27
|
+
* In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here.
|
|
28
|
+
*/
|
|
20
29
|
agentId?: string | null | undefined;
|
|
30
|
+
/**
|
|
31
|
+
* The metadata of your choice to be associated with the batch inference job.
|
|
32
|
+
*/
|
|
21
33
|
metadata?: { [k: string]: string } | null | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* The timeout in hours for the batch inference job.
|
|
36
|
+
*/
|
|
22
37
|
timeoutHours?: number | undefined;
|
|
23
38
|
};
|
|
24
39
|
|
|
@@ -77,6 +77,9 @@ export type Messages =
|
|
|
77
77
|
| (UserMessage & { role: "user" })
|
|
78
78
|
| (AssistantMessage & { role: "assistant" });
|
|
79
79
|
|
|
80
|
+
/**
|
|
81
|
+
* Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
|
|
82
|
+
*/
|
|
80
83
|
export type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum;
|
|
81
84
|
|
|
82
85
|
export type ChatCompletionRequest = {
|
|
@@ -108,6 +111,7 @@ export type ChatCompletionRequest = {
|
|
|
108
111
|
* The seed to use for random sampling. If set, different calls will generate deterministic results.
|
|
109
112
|
*/
|
|
110
113
|
randomSeed?: number | null | undefined;
|
|
114
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
111
115
|
/**
|
|
112
116
|
* The prompt(s) to generate completions for, encoded as a list of dict with role and content.
|
|
113
117
|
*/
|
|
@@ -117,22 +121,37 @@ export type ChatCompletionRequest = {
|
|
|
117
121
|
| (UserMessage & { role: "user" })
|
|
118
122
|
| (AssistantMessage & { role: "assistant" })
|
|
119
123
|
>;
|
|
124
|
+
/**
|
|
125
|
+
* Specify the format that the model must output. By default it will use `{ "type": "text" }`. 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. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
|
|
126
|
+
*/
|
|
120
127
|
responseFormat?: ResponseFormat | undefined;
|
|
128
|
+
/**
|
|
129
|
+
* A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
|
|
130
|
+
*/
|
|
121
131
|
tools?: Array<Tool> | null | undefined;
|
|
132
|
+
/**
|
|
133
|
+
* Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
|
|
134
|
+
*/
|
|
122
135
|
toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
|
|
123
136
|
/**
|
|
124
|
-
* 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.
|
|
137
|
+
* The `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.
|
|
125
138
|
*/
|
|
126
139
|
presencePenalty?: number | undefined;
|
|
127
140
|
/**
|
|
128
|
-
* 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.
|
|
141
|
+
* The `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.
|
|
129
142
|
*/
|
|
130
143
|
frequencyPenalty?: number | undefined;
|
|
131
144
|
/**
|
|
132
145
|
* Number of completions to return for each request, input tokens are only billed once.
|
|
133
146
|
*/
|
|
134
147
|
n?: number | null | undefined;
|
|
148
|
+
/**
|
|
149
|
+
* Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
|
|
150
|
+
*/
|
|
135
151
|
prediction?: Prediction | undefined;
|
|
152
|
+
/**
|
|
153
|
+
* Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
|
|
154
|
+
*/
|
|
136
155
|
parallelToolCalls?: boolean | undefined;
|
|
137
156
|
/**
|
|
138
157
|
* Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
|
|
@@ -329,6 +348,7 @@ export const ChatCompletionRequest$inboundSchema: z.ZodType<
|
|
|
329
348
|
stream: z.boolean().default(false),
|
|
330
349
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
331
350
|
random_seed: z.nullable(z.number().int()).optional(),
|
|
351
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
332
352
|
messages: z.array(
|
|
333
353
|
z.union([
|
|
334
354
|
SystemMessage$inboundSchema.and(
|
|
@@ -388,6 +408,7 @@ export type ChatCompletionRequest$Outbound = {
|
|
|
388
408
|
stream: boolean;
|
|
389
409
|
stop?: string | Array<string> | undefined;
|
|
390
410
|
random_seed?: number | null | undefined;
|
|
411
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
391
412
|
messages: Array<
|
|
392
413
|
| (SystemMessage$Outbound & { role: "system" })
|
|
393
414
|
| (ToolMessage$Outbound & { role: "tool" })
|
|
@@ -419,6 +440,7 @@ export const ChatCompletionRequest$outboundSchema: z.ZodType<
|
|
|
419
440
|
stream: z.boolean().default(false),
|
|
420
441
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
421
442
|
randomSeed: z.nullable(z.number().int()).optional(),
|
|
443
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
422
444
|
messages: z.array(
|
|
423
445
|
z.union([
|
|
424
446
|
SystemMessage$outboundSchema.and(
|
|
@@ -77,6 +77,9 @@ export type ChatCompletionStreamRequestMessages =
|
|
|
77
77
|
| (UserMessage & { role: "user" })
|
|
78
78
|
| (AssistantMessage & { role: "assistant" });
|
|
79
79
|
|
|
80
|
+
/**
|
|
81
|
+
* Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
|
|
82
|
+
*/
|
|
80
83
|
export type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum;
|
|
81
84
|
|
|
82
85
|
export type ChatCompletionStreamRequest = {
|
|
@@ -105,6 +108,7 @@ export type ChatCompletionStreamRequest = {
|
|
|
105
108
|
* The seed to use for random sampling. If set, different calls will generate deterministic results.
|
|
106
109
|
*/
|
|
107
110
|
randomSeed?: number | null | undefined;
|
|
111
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
108
112
|
/**
|
|
109
113
|
* The prompt(s) to generate completions for, encoded as a list of dict with role and content.
|
|
110
114
|
*/
|
|
@@ -114,22 +118,37 @@ export type ChatCompletionStreamRequest = {
|
|
|
114
118
|
| (UserMessage & { role: "user" })
|
|
115
119
|
| (AssistantMessage & { role: "assistant" })
|
|
116
120
|
>;
|
|
121
|
+
/**
|
|
122
|
+
* Specify the format that the model must output. By default it will use `{ "type": "text" }`. 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. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
|
|
123
|
+
*/
|
|
117
124
|
responseFormat?: ResponseFormat | undefined;
|
|
125
|
+
/**
|
|
126
|
+
* A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
|
|
127
|
+
*/
|
|
118
128
|
tools?: Array<Tool> | null | undefined;
|
|
129
|
+
/**
|
|
130
|
+
* Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
|
|
131
|
+
*/
|
|
119
132
|
toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
|
|
120
133
|
/**
|
|
121
|
-
* 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.
|
|
134
|
+
* The `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.
|
|
122
135
|
*/
|
|
123
136
|
presencePenalty?: number | undefined;
|
|
124
137
|
/**
|
|
125
|
-
* 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.
|
|
138
|
+
* The `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.
|
|
126
139
|
*/
|
|
127
140
|
frequencyPenalty?: number | undefined;
|
|
128
141
|
/**
|
|
129
142
|
* Number of completions to return for each request, input tokens are only billed once.
|
|
130
143
|
*/
|
|
131
144
|
n?: number | null | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
|
|
147
|
+
*/
|
|
132
148
|
prediction?: Prediction | undefined;
|
|
149
|
+
/**
|
|
150
|
+
* Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
|
|
151
|
+
*/
|
|
133
152
|
parallelToolCalls?: boolean | undefined;
|
|
134
153
|
/**
|
|
135
154
|
* Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
|
|
@@ -350,6 +369,7 @@ export const ChatCompletionStreamRequest$inboundSchema: z.ZodType<
|
|
|
350
369
|
stream: z.boolean().default(true),
|
|
351
370
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
352
371
|
random_seed: z.nullable(z.number().int()).optional(),
|
|
372
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
353
373
|
messages: z.array(
|
|
354
374
|
z.union([
|
|
355
375
|
SystemMessage$inboundSchema.and(
|
|
@@ -409,6 +429,7 @@ export type ChatCompletionStreamRequest$Outbound = {
|
|
|
409
429
|
stream: boolean;
|
|
410
430
|
stop?: string | Array<string> | undefined;
|
|
411
431
|
random_seed?: number | null | undefined;
|
|
432
|
+
metadata?: { [k: string]: any } | null | undefined;
|
|
412
433
|
messages: Array<
|
|
413
434
|
| (SystemMessage$Outbound & { role: "system" })
|
|
414
435
|
| (ToolMessage$Outbound & { role: "tool" })
|
|
@@ -440,6 +461,7 @@ export const ChatCompletionStreamRequest$outboundSchema: z.ZodType<
|
|
|
440
461
|
stream: z.boolean().default(true),
|
|
441
462
|
stop: z.union([z.string(), z.array(z.string())]).optional(),
|
|
442
463
|
randomSeed: z.nullable(z.number().int()).optional(),
|
|
464
|
+
metadata: z.nullable(z.record(z.any())).optional(),
|
|
443
465
|
messages: z.array(
|
|
444
466
|
z.union([
|
|
445
467
|
SystemMessage$outboundSchema.and(
|