@mistralai/mistralai 1.10.0 → 1.11.0

package/src/models/components/conversationrequest.ts

@@ -77,6 +77,9 @@ 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" })
@@ -86,12 +89,13 @@ export type ConversationRequest = {
       | (WebSearchTool & { type: "web_search" })
       | (WebSearchPremiumTool & { type: "web_search_premium" })
     >
-    | 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;
 };
 
@@ -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([
-        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 })),
-        ),
-      ]),
-    ),
+  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",
   });
 });
 
@@ -301,12 +306,13 @@ export type ConversationRequest$Outbound = {
       | (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;
+  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([
-        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 })),
-        ),
-      ]),
-    ),
+  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/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",
   });
 });
 

package/src/models/components/conversationstreamrequest.ts

@@ -82,6 +82,9 @@ export type ConversationStreamRequest = {
     | null
     | undefined;
   instructions?: string | null | undefined;
+  /**
+   * List of tools which are available to the model during the conversation.
+   */
   tools?:
     | Array<
       | (DocumentLibraryTool & { type: "document_library" })
@@ -91,12 +94,13 @@ export type ConversationStreamRequest = {
       | (WebSearchTool & { type: "web_search" })
       | (WebSearchPremiumTool & { type: "web_search_premium" })
     >
-    | 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;
 };
 
@@ -254,52 +258,53 @@ export const ConversationStreamRequest$inboundSchema: z.ZodType<
     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 })),
-        ),
-      ]),
-    ),
+  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",
   });
 });
 
@@ -319,12 +324,13 @@ export type ConversationStreamRequest$Outbound = {
       | (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;
+  metadata?: { [k: string]: any } | null | undefined;
   agent_id?: string | null | undefined;
+  agent_version?: number | null | undefined;
   model?: string | null | undefined;
 };
 
@@ -341,52 +347,53 @@ export const ConversationStreamRequest$outboundSchema: z.ZodType<
     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 })),
-        ),
-      ]),
-    ),
+  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/documentout.ts

@@ -11,20 +11,22 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 export type DocumentOut = {
   id: string;
   libraryId: string;
-  hash: string;
-  mimeType: string;
-  extension: string;
-  size: number;
+  hash: string | null;
+  mimeType: string | null;
+  extension: string | null;
+  size: number | null;
   name: string;
   summary?: string | null | undefined;
   createdAt: Date;
   lastProcessedAt?: Date | null | undefined;
   numberOfPages?: number | null | undefined;
   processingStatus: string;
-  uploadedById: string;
+  uploadedById: string | null;
   uploadedByType: string;
   tokensProcessingMainContent?: number | null | undefined;
   tokensProcessingSummary?: number | null | undefined;
+  url?: string | null | undefined;
+  attributes?: { [k: string]: any } | null | undefined;
   tokensProcessingTotal: number;
 };
 
@@ -36,10 +38,10 @@ export const DocumentOut$inboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   library_id: z.string(),
-  hash: z.string(),
-  mime_type: z.string(),
-  extension: z.string(),
-  size: z.number().int(),
+  hash: z.nullable(z.string()),
+  mime_type: z.nullable(z.string()),
+  extension: z.nullable(z.string()),
+  size: z.nullable(z.number().int()),
   name: z.string(),
   summary: z.nullable(z.string()).optional(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -48,10 +50,12 @@ export const DocumentOut$inboundSchema: z.ZodType<
   ).optional(),
   number_of_pages: z.nullable(z.number().int()).optional(),
   processing_status: z.string(),
-  uploaded_by_id: z.string(),
+  uploaded_by_id: z.nullable(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(),
+  url: z.nullable(z.string()).optional(),
+  attributes: z.nullable(z.record(z.any())).optional(),
   tokens_processing_total: z.number().int(),
 }).transform((v) => {
   return remap$(v, {
@@ -73,20 +77,22 @@ export const DocumentOut$inboundSchema: z.ZodType<
 export type DocumentOut$Outbound = {
   id: string;
   library_id: string;
-  hash: string;
-  mime_type: string;
-  extension: string;
-  size: number;
+  hash: string | null;
+  mime_type: string | null;
+  extension: string | null;
+  size: number | null;
   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_id: string | null;
   uploaded_by_type: string;
   tokens_processing_main_content?: number | null | undefined;
   tokens_processing_summary?: number | null | undefined;
+  url?: string | null | undefined;
+  attributes?: { [k: string]: any } | null | undefined;
   tokens_processing_total: number;
 };
 
@@ -98,10 +104,10 @@ export const DocumentOut$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   libraryId: z.string(),
-  hash: z.string(),
-  mimeType: z.string(),
-  extension: z.string(),
-  size: z.number().int(),
+  hash: z.nullable(z.string()),
+  mimeType: z.nullable(z.string()),
+  extension: z.nullable(z.string()),
+  size: z.nullable(z.number().int()),
   name: z.string(),
   summary: z.nullable(z.string()).optional(),
   createdAt: z.date().transform(v => v.toISOString()),
@@ -109,10 +115,12 @@ export const DocumentOut$outboundSchema: z.ZodType<
     .optional(),
   numberOfPages: z.nullable(z.number().int()).optional(),
   processingStatus: z.string(),
-  uploadedById: z.string(),
+  uploadedById: z.nullable(z.string()),
   uploadedByType: z.string(),
   tokensProcessingMainContent: z.nullable(z.number().int()).optional(),
   tokensProcessingSummary: z.nullable(z.number().int()).optional(),
+  url: z.nullable(z.string()).optional(),
+  attributes: z.nullable(z.record(z.any())).optional(),
   tokensProcessingTotal: z.number().int(),
 }).transform((v) => {
   return remap$(v, {