@mistralai/mistralai 1.9.19 → 1.11.0

package/src/models/components/conversationrequest.ts

@@ -64,12 +64,12 @@ export const HandoffExecution = {
 export type HandoffExecution = ClosedEnum<typeof HandoffExecution>;
 
 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" })
-  | (DocumentLibraryTool & { type: "document_library" })
-  | (FunctionTool & { type: "function" });
+  | (WebSearchPremiumTool & { type: "web_search_premium" });
 
 export type ConversationRequest = {
   inputs: ConversationInputs;
@@ -77,21 +77,25 @@ export type ConversationRequest = {
   store?: boolean | null | undefined;
   handoffExecution?: HandoffExecution | null | undefined;
   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" })
-      | (DocumentLibraryTool & { type: "document_library" })
-      | (FunctionTool & { type: "function" })
     >
-    | null
     | undefined;
   completionArgs?: CompletionArgs | null | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   agentId?: string | null | undefined;
+  agentVersion?: number | null | undefined;
   model?: string | null | undefined;
 };
 
@@ -119,6 +123,16 @@ export namespace HandoffExecution$ {
 /** @internal */
 export const Tools$inboundSchema: z.ZodType<Tools, 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,
@@ -139,26 +153,16 @@ export const Tools$inboundSchema: z.ZodType<Tools, z.ZodTypeDef, unknown> = z
         type: v.type,
       })),
     ),
-    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,
-      })),
-    ),
   ]);
 
 /** @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" })
-  | (DocumentLibraryTool$Outbound & { type: "document_library" })
-  | (FunctionTool$Outbound & { type: "function" });
+  | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" });
 
 /** @internal */
 export const Tools$outboundSchema: z.ZodType<
@@ -166,6 +170,16 @@ export const Tools$outboundSchema: z.ZodType<
   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,
@@ -186,16 +200,6 @@ export const Tools$outboundSchema: z.ZodType<
       type: v.type,
     })),
   ),
-  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,
-    })),
-  ),
 ]);
 
 /**
@@ -236,52 +240,53 @@ export const ConversationRequest$inboundSchema: z.ZodType<
   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([
-        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 })),
-        ),
-        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,
-          })),
-        ),
-      ]),
-    ),
+  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: z.nullable(CompletionArgs$inboundSchema).optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   agent_id: z.nullable(z.string()).optional(),
+  agent_version: z.nullable(z.number().int()).optional(),
   model: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "handoff_execution": "handoffExecution",
     "completion_args": "completionArgs",
     "agent_id": "agentId",
+    "agent_version": "agentVersion",
   });
 });
 
@@ -294,19 +299,20 @@ export type ConversationRequest$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" })
-      | (DocumentLibraryTool$Outbound & { type: "document_library" })
-      | (FunctionTool$Outbound & { type: "function" })
     >
-    | null
     | undefined;
   completion_args?: CompletionArgs$Outbound | null | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   agent_id?: string | null | undefined;
+  agent_version?: number | null | undefined;
   model?: string | null | undefined;
 };
 
@@ -321,52 +327,53 @@ export const ConversationRequest$outboundSchema: z.ZodType<
   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([
-        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 })),
-        ),
-        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,
-          })),
-        ),
-      ]),
-    ),
+  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: z.nullable(CompletionArgs$outboundSchema).optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   agentId: z.nullable(z.string()).optional(),
+  agentVersion: z.nullable(z.number().int()).optional(),
   model: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     handoffExecution: "handoff_execution",
     completionArgs: "completion_args",
     agentId: "agent_id",
+    agentVersion: "agent_version",
   });
 });
 

package/src/models/components/conversationresponse.ts

@@ -47,10 +47,10 @@ export type ConversationResponseObject = ClosedEnum<
 >;
 
 export type Outputs =
-  | ToolExecutionEntry
+  | AgentHandoffEntry
   | FunctionCallEntry
-  | MessageOutputEntry
-  | AgentHandoffEntry;
+  | ToolExecutionEntry
+  | MessageOutputEntry;
 
 /**
  * The response after appending new entries to the conversation.
@@ -59,10 +59,10 @@ export type ConversationResponse = {
   object?: ConversationResponseObject | undefined;
   conversationId: string;
   outputs: Array<
-    | ToolExecutionEntry
+    | AgentHandoffEntry
     | FunctionCallEntry
+    | ToolExecutionEntry
     | MessageOutputEntry
-    | AgentHandoffEntry
   >;
   usage: ConversationUsageInfo;
 };
@@ -91,18 +91,18 @@ export namespace ConversationResponseObject$ {
 /** @internal */
 export const Outputs$inboundSchema: z.ZodType<Outputs, z.ZodTypeDef, unknown> =
   z.union([
-    ToolExecutionEntry$inboundSchema,
+    AgentHandoffEntry$inboundSchema,
     FunctionCallEntry$inboundSchema,
+    ToolExecutionEntry$inboundSchema,
     MessageOutputEntry$inboundSchema,
-    AgentHandoffEntry$inboundSchema,
   ]);
 
 /** @internal */
 export type Outputs$Outbound =
-  | ToolExecutionEntry$Outbound
+  | AgentHandoffEntry$Outbound
   | FunctionCallEntry$Outbound
-  | MessageOutputEntry$Outbound
-  | AgentHandoffEntry$Outbound;
+  | ToolExecutionEntry$Outbound
+  | MessageOutputEntry$Outbound;
 
 /** @internal */
 export const Outputs$outboundSchema: z.ZodType<
@@ -110,10 +110,10 @@ export const Outputs$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   Outputs
 > = z.union([
-  ToolExecutionEntry$outboundSchema,
+  AgentHandoffEntry$outboundSchema,
   FunctionCallEntry$outboundSchema,
+  ToolExecutionEntry$outboundSchema,
   MessageOutputEntry$outboundSchema,
-  AgentHandoffEntry$outboundSchema,
 ]);
 
 /**
@@ -155,10 +155,10 @@ export const ConversationResponse$inboundSchema: z.ZodType<
   conversation_id: z.string(),
   outputs: z.array(
     z.union([
-      ToolExecutionEntry$inboundSchema,
+      AgentHandoffEntry$inboundSchema,
       FunctionCallEntry$inboundSchema,
+      ToolExecutionEntry$inboundSchema,
       MessageOutputEntry$inboundSchema,
-      AgentHandoffEntry$inboundSchema,
     ]),
   ),
   usage: ConversationUsageInfo$inboundSchema,
@@ -173,10 +173,10 @@ export type ConversationResponse$Outbound = {
   object: string;
   conversation_id: string;
   outputs: Array<
-    | ToolExecutionEntry$Outbound
+    | AgentHandoffEntry$Outbound
     | FunctionCallEntry$Outbound
+    | ToolExecutionEntry$Outbound
     | MessageOutputEntry$Outbound
-    | AgentHandoffEntry$Outbound
   >;
   usage: ConversationUsageInfo$Outbound;
 };
@@ -193,10 +193,10 @@ export const ConversationResponse$outboundSchema: z.ZodType<
   conversationId: z.string(),
   outputs: z.array(
     z.union([
-      ToolExecutionEntry$outboundSchema,
+      AgentHandoffEntry$outboundSchema,
       FunctionCallEntry$outboundSchema,
+      ToolExecutionEntry$outboundSchema,
       MessageOutputEntry$outboundSchema,
-      AgentHandoffEntry$outboundSchema,
     ]),
   ),
   usage: ConversationUsageInfo$outboundSchema,

package/src/models/components/conversationrestartrequest.ts

@@ -44,7 +44,15 @@ export type ConversationRestartRequest = {
    * White-listed arguments from the completion API
    */
   completionArgs?: CompletionArgs | undefined;
+  /**
+   * Custom metadata for the conversation.
+   */
+  metadata?: { [k: string]: any } | null | undefined;
   fromEntryId: string;
+  /**
+   * Specific version of the agent to use when restarting. If not provided, uses the current version.
+   */
+  agentVersion?: number | null | undefined;
 };
 
 /** @internal */
@@ -82,12 +90,15 @@ export const ConversationRestartRequest$inboundSchema: z.ZodType<
   handoff_execution: ConversationRestartRequestHandoffExecution$inboundSchema
     .default("server"),
   completion_args: CompletionArgs$inboundSchema.optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   from_entry_id: z.string(),
+  agent_version: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "handoff_execution": "handoffExecution",
     "completion_args": "completionArgs",
     "from_entry_id": "fromEntryId",
+    "agent_version": "agentVersion",
   });
 });
 
@@ -98,7 +109,9 @@ export type ConversationRestartRequest$Outbound = {
   store: boolean;
   handoff_execution: string;
   completion_args?: CompletionArgs$Outbound | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   from_entry_id: string;
+  agent_version?: number | null | undefined;
 };
 
 /** @internal */
@@ -113,12 +126,15 @@ export const ConversationRestartRequest$outboundSchema: z.ZodType<
   handoffExecution: ConversationRestartRequestHandoffExecution$outboundSchema
     .default("server"),
   completionArgs: CompletionArgs$outboundSchema.optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   fromEntryId: z.string(),
+  agentVersion: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     handoffExecution: "handoff_execution",
     completionArgs: "completion_args",
     fromEntryId: "from_entry_id",
+    agentVersion: "agent_version",
   });
 });
 

package/src/models/components/conversationrestartstreamrequest.ts

@@ -46,7 +46,15 @@ export type ConversationRestartStreamRequest = {
    * White-listed arguments from the completion API
    */
   completionArgs?: CompletionArgs | undefined;
+  /**
+   * Custom metadata for the conversation.
+   */
+  metadata?: { [k: string]: any } | null | undefined;
   fromEntryId: string;
+  /**
+   * Specific version of the agent to use when restarting. If not provided, uses the current version.
+   */
+  agentVersion?: number | null | undefined;
 };
 
 /** @internal */
@@ -86,12 +94,15 @@ export const ConversationRestartStreamRequest$inboundSchema: z.ZodType<
       "server",
     ),
   completion_args: CompletionArgs$inboundSchema.optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   from_entry_id: z.string(),
+  agent_version: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "handoff_execution": "handoffExecution",
     "completion_args": "completionArgs",
     "from_entry_id": "fromEntryId",
+    "agent_version": "agentVersion",
   });
 });
 
@@ -102,7 +113,9 @@ export type ConversationRestartStreamRequest$Outbound = {
   store: boolean;
   handoff_execution: string;
   completion_args?: CompletionArgs$Outbound | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   from_entry_id: string;
+  agent_version?: number | null | undefined;
 };
 
 /** @internal */
@@ -119,12 +132,15 @@ export const ConversationRestartStreamRequest$outboundSchema: z.ZodType<
       "server",
     ),
   completionArgs: CompletionArgs$outboundSchema.optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   fromEntryId: z.string(),
+  agentVersion: z.nullable(z.number().int()).optional(),
 }).transform((v) => {
   return remap$(v, {
     handoffExecution: "handoff_execution",
     completionArgs: "completion_args",
     fromEntryId: "from_entry_id",
+    agentVersion: "agent_version",
   });
 });