@mistralai/mistralai 1.9.19 → 1.11.0

package/src/models/components/conversationstreamrequest.ts

@@ -66,12 +66,12 @@ export type ConversationStreamRequestHandoffExecution = ClosedEnum<
 >;
 
 export type ConversationStreamRequestTools =
+  | (DocumentLibraryTool & { type: "document_library" })
+  | (FunctionTool & { type: "function" })
   | (CodeInterpreterTool & { type: "code_interpreter" })
   | (ImageGenerationTool & { type: "image_generation" })
   | (WebSearchTool & { type: "web_search" })
-  | (WebSearchPremiumTool & { type: "web_search_premium" })
-  | (DocumentLibraryTool & { type: "document_library" })
-  | (FunctionTool & { type: "function" });
+  | (WebSearchPremiumTool & { type: "web_search_premium" });
 
 export type ConversationStreamRequest = {
   inputs: ConversationInputs;
@@ -82,21 +82,25 @@ 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" })
+      | (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;
 };
 
@@ -129,6 +133,16 @@ export const ConversationStreamRequestTools$inboundSchema: z.ZodType<
   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,
@@ -149,26 +163,16 @@ export const ConversationStreamRequestTools$inboundSchema: z.ZodType<
       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 ConversationStreamRequestTools$Outbound =
+  | (DocumentLibraryTool$Outbound & { type: "document_library" })
+  | (FunctionTool$Outbound & { type: "function" })
   | (CodeInterpreterTool$Outbound & { type: "code_interpreter" })
   | (ImageGenerationTool$Outbound & { type: "image_generation" })
   | (WebSearchTool$Outbound & { type: "web_search" })
-  | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" })
-  | (DocumentLibraryTool$Outbound & { type: "document_library" })
-  | (FunctionTool$Outbound & { type: "function" });
+  | (WebSearchPremiumTool$Outbound & { type: "web_search_premium" });
 
 /** @internal */
 export const ConversationStreamRequestTools$outboundSchema: z.ZodType<
@@ -176,6 +180,16 @@ export const ConversationStreamRequestTools$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ConversationStreamRequestTools
 > = z.union([
+  DocumentLibraryTool$outboundSchema.and(
+    z.object({ type: z.literal("document_library") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
+  FunctionTool$outboundSchema.and(
+    z.object({ type: z.literal("function") }).transform((v) => ({
+      type: v.type,
+    })),
+  ),
   CodeInterpreterTool$outboundSchema.and(
     z.object({ type: z.literal("code_interpreter") }).transform((v) => ({
       type: v.type,
@@ -196,16 +210,6 @@ export const ConversationStreamRequestTools$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,
-    })),
-  ),
 ]);
 
 /**
@@ -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([
-        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",
   });
 });
 
@@ -312,19 +317,20 @@ export type ConversationStreamRequest$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;
 };
 
@@ -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([
-        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/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, {

package/src/models/components/documentupdatein.ts

@@ -7,10 +7,109 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+export type Attributes =
+  | boolean
+  | string
+  | number
+  | number
+  | Date
+  | Array<string>
+  | Array<number>
+  | Array<number>
+  | Array<boolean>;
+
 export type DocumentUpdateIn = {
   name?: string | null | undefined;
+  attributes?:
+    | {
+      [k: string]:
+        | boolean
+        | string
+        | number
+        | number
+        | Date
+        | Array<string>
+        | Array<number>
+        | Array<number>
+        | Array<boolean>;
+    }
+    | null
+    | undefined;
 };
 
+/** @internal */
+export const Attributes$inboundSchema: z.ZodType<
+  Attributes,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.boolean(),
+  z.string(),
+  z.number().int(),
+  z.number(),
+  z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  z.array(z.string()),
+  z.array(z.number().int()),
+  z.array(z.number()),
+  z.array(z.boolean()),
+]);
+
+/** @internal */
+export type Attributes$Outbound =
+  | boolean
+  | string
+  | number
+  | number
+  | string
+  | Array<string>
+  | Array<number>
+  | Array<number>
+  | Array<boolean>;
+
+/** @internal */
+export const Attributes$outboundSchema: z.ZodType<
+  Attributes$Outbound,
+  z.ZodTypeDef,
+  Attributes
+> = z.union([
+  z.boolean(),
+  z.string(),
+  z.number().int(),
+  z.number(),
+  z.date().transform(v => v.toISOString()),
+  z.array(z.string()),
+  z.array(z.number().int()),
+  z.array(z.number()),
+  z.array(z.boolean()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Attributes$ {
+  /** @deprecated use `Attributes$inboundSchema` instead. */
+  export const inboundSchema = Attributes$inboundSchema;
+  /** @deprecated use `Attributes$outboundSchema` instead. */
+  export const outboundSchema = Attributes$outboundSchema;
+  /** @deprecated use `Attributes$Outbound` instead. */
+  export type Outbound = Attributes$Outbound;
+}
+
+export function attributesToJSON(attributes: Attributes): string {
+  return JSON.stringify(Attributes$outboundSchema.parse(attributes));
+}
+
+export function attributesFromJSON(
+  jsonString: string,
+): SafeParseResult<Attributes, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Attributes$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Attributes' from JSON`,
+  );
+}
+
 /** @internal */
 export const DocumentUpdateIn$inboundSchema: z.ZodType<
   DocumentUpdateIn,
@@ -18,11 +117,41 @@ export const DocumentUpdateIn$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   name: z.nullable(z.string()).optional(),
+  attributes: z.nullable(
+    z.record(
+      z.union([
+        z.boolean(),
+        z.string(),
+        z.number().int(),
+        z.number(),
+        z.string().datetime({ offset: true }).transform(v => new Date(v)),
+        z.array(z.string()),
+        z.array(z.number().int()),
+        z.array(z.number()),
+        z.array(z.boolean()),
+      ]),
+    ),
+  ).optional(),
 });
 
 /** @internal */
 export type DocumentUpdateIn$Outbound = {
   name?: string | null | undefined;
+  attributes?:
+    | {
+      [k: string]:
+        | boolean
+        | string
+        | number
+        | number
+        | string
+        | Array<string>
+        | Array<number>
+        | Array<number>
+        | Array<boolean>;
+    }
+    | null
+    | undefined;
 };
 
 /** @internal */
@@ -32,6 +161,21 @@ export const DocumentUpdateIn$outboundSchema: z.ZodType<
   DocumentUpdateIn
 > = z.object({
   name: z.nullable(z.string()).optional(),
+  attributes: z.nullable(
+    z.record(
+      z.union([
+        z.boolean(),
+        z.string(),
+        z.number().int(),
+        z.number(),
+        z.date().transform(v => v.toISOString()),
+        z.array(z.string()),
+        z.array(z.number().int()),
+        z.array(z.number()),
+        z.array(z.boolean()),
+      ]),
+    ),
+  ).optional(),
 });
 
 /**

package/src/models/components/embeddingrequest.ts

@@ -19,21 +19,21 @@ import {
 } from "./encodingformat.js";
 
 /**
- * Text to embed.
+ * The text content to be embedded, can be a string or an array of strings for fast processing in bulk.
  */
 export type EmbeddingRequestInputs = string | Array<string>;
 
 export type EmbeddingRequest = {
   /**
-   * ID of the model to use.
+   * The ID of the model to be used for embedding.
    */
   model: string;
   /**
-   * Text to embed.
+   * The text content to be embedded, can be a string or an array of strings for fast processing in bulk.
    */
   inputs: string | Array<string>;
   /**
-   * The dimension of the output embeddings.
+   * The dimension of the output embeddings when feature available. If not provided, a default output dimension will be used.
    */
   outputDimension?: number | null | undefined;
   outputDtype?: EmbeddingDtype | undefined;

package/src/models/components/fimcompletionrequest.ts

@@ -15,11 +15,7 @@ export type FIMCompletionRequestStop = string | Array<string>;
 
 export type FIMCompletionRequest = {
   /**
-   * ID of the model to use. Only compatible for now with:
-   *
-   * @remarks
-   *   - `codestral-2405`
-   *   - `codestral-latest`
+   * ID of the model with FIM to use.
    */
   model: string;
   /**
@@ -46,6 +42,7 @@ export type FIMCompletionRequest = {
    * The seed to use for random sampling. If set, different calls will generate deterministic results.
    */
   randomSeed?: number | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * The text/code to complete.
    */
@@ -121,6 +118,7 @@ export const FIMCompletionRequest$inboundSchema: z.ZodType<
   stream: z.boolean().default(false),
   stop: z.union([z.string(), z.array(z.string())]).optional(),
   random_seed: z.nullable(z.number().int()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   prompt: z.string(),
   suffix: z.nullable(z.string()).optional(),
   min_tokens: z.nullable(z.number().int()).optional(),
@@ -142,6 +140,7 @@ export type FIMCompletionRequest$Outbound = {
   stream: boolean;
   stop?: string | Array<string> | undefined;
   random_seed?: number | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   prompt: string;
   suffix?: string | null | undefined;
   min_tokens?: number | null | undefined;
@@ -160,6 +159,7 @@ export const FIMCompletionRequest$outboundSchema: z.ZodType<
   stream: z.boolean().default(false),
   stop: z.union([z.string(), z.array(z.string())]).optional(),
   randomSeed: z.nullable(z.number().int()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   prompt: z.string(),
   suffix: z.nullable(z.string()).optional(),
   minTokens: z.nullable(z.number().int()).optional(),