@mistralai/mistralai 1.10.0 → 1.11.0

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(),

package/src/models/components/fimcompletionstreamrequest.ts

@@ -15,11 +15,7 @@ export type FIMCompletionStreamRequestStop = string | Array<string>;
 
 export type FIMCompletionStreamRequest = {
   /**
-   * 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;
   /**
@@ -43,6 +39,7 @@ export type FIMCompletionStreamRequest = {
    * 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.
    */
@@ -120,6 +117,7 @@ export const FIMCompletionStreamRequest$inboundSchema: z.ZodType<
   stream: z.boolean().default(true),
   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(),
@@ -141,6 +139,7 @@ export type FIMCompletionStreamRequest$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;
@@ -159,6 +158,7 @@ export const FIMCompletionStreamRequest$outboundSchema: z.ZodType<
   stream: z.boolean().default(true),
   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(),

package/src/models/components/index.ts

@@ -138,12 +138,14 @@ export * from "./ocrpagedimensions.js";
 export * from "./ocrpageobject.js";
 export * from "./ocrrequest.js";
 export * from "./ocrresponse.js";
+export * from "./ocrtableobject.js";
 export * from "./ocrusageinfo.js";
 export * from "./outputcontentchunks.js";
 export * from "./paginationinfo.js";
 export * from "./prediction.js";
 export * from "./processingstatusout.js";
 export * from "./referencechunk.js";
+export * from "./requestsource.js";
 export * from "./responsedoneevent.js";
 export * from "./responseerrorevent.js";
 export * from "./responseformat.js";

package/src/models/components/libraryout.ts

@@ -13,18 +13,21 @@ export type LibraryOut = {
   name: string;
   createdAt: Date;
   updatedAt: Date;
-  ownerId: string;
+  ownerId: string | null;
   ownerType: string;
   totalSize: number;
   nbDocuments: number;
   chunkSize: number | null;
   emoji?: string | null | undefined;
   description?: string | null | undefined;
-  generatedName?: string | null | undefined;
   generatedDescription?: string | null | undefined;
   explicitUserMembersCount?: number | null | undefined;
   explicitWorkspaceMembersCount?: number | null | undefined;
   orgSharingRole?: string | null | undefined;
+  /**
+   * Generated Name
+   */
+  generatedName?: string | null | undefined;
 };
 
 /** @internal */
@@ -37,18 +40,18 @@ export const LibraryOut$inboundSchema: z.ZodType<
   name: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
   updated_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
-  owner_id: z.string(),
+  owner_id: z.nullable(z.string()),
   owner_type: z.string(),
   total_size: z.number().int(),
   nb_documents: z.number().int(),
   chunk_size: z.nullable(z.number().int()),
   emoji: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
-  generated_name: z.nullable(z.string()).optional(),
   generated_description: z.nullable(z.string()).optional(),
   explicit_user_members_count: z.nullable(z.number().int()).optional(),
   explicit_workspace_members_count: z.nullable(z.number().int()).optional(),
   org_sharing_role: z.nullable(z.string()).optional(),
+  generated_name: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     "created_at": "createdAt",
@@ -58,11 +61,11 @@ export const LibraryOut$inboundSchema: z.ZodType<
     "total_size": "totalSize",
     "nb_documents": "nbDocuments",
     "chunk_size": "chunkSize",
-    "generated_name": "generatedName",
     "generated_description": "generatedDescription",
     "explicit_user_members_count": "explicitUserMembersCount",
     "explicit_workspace_members_count": "explicitWorkspaceMembersCount",
     "org_sharing_role": "orgSharingRole",
+    "generated_name": "generatedName",
   });
 });
 
@@ -72,18 +75,18 @@ export type LibraryOut$Outbound = {
   name: string;
   created_at: string;
   updated_at: string;
-  owner_id: string;
+  owner_id: string | null;
   owner_type: string;
   total_size: number;
   nb_documents: number;
   chunk_size: number | null;
   emoji?: string | null | undefined;
   description?: string | null | undefined;
-  generated_name?: string | null | undefined;
   generated_description?: string | null | undefined;
   explicit_user_members_count?: number | null | undefined;
   explicit_workspace_members_count?: number | null | undefined;
   org_sharing_role?: string | null | undefined;
+  generated_name?: string | null | undefined;
 };
 
 /** @internal */
@@ -96,18 +99,18 @@ export const LibraryOut$outboundSchema: z.ZodType<
   name: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),
   updatedAt: z.date().transform(v => v.toISOString()),
-  ownerId: z.string(),
+  ownerId: z.nullable(z.string()),
   ownerType: z.string(),
   totalSize: z.number().int(),
   nbDocuments: z.number().int(),
   chunkSize: z.nullable(z.number().int()),
   emoji: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
-  generatedName: z.nullable(z.string()).optional(),
   generatedDescription: z.nullable(z.string()).optional(),
   explicitUserMembersCount: z.nullable(z.number().int()).optional(),
   explicitWorkspaceMembersCount: z.nullable(z.number().int()).optional(),
   orgSharingRole: z.nullable(z.string()).optional(),
+  generatedName: z.nullable(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {
     createdAt: "created_at",
@@ -117,11 +120,11 @@ export const LibraryOut$outboundSchema: z.ZodType<
     totalSize: "total_size",
     nbDocuments: "nb_documents",
     chunkSize: "chunk_size",
-    generatedName: "generated_name",
     generatedDescription: "generated_description",
     explicitUserMembersCount: "explicit_user_members_count",
     explicitWorkspaceMembersCount: "explicit_workspace_members_count",
     orgSharingRole: "org_sharing_role",
+    generatedName: "generated_name",
   });
 });
 

package/src/models/components/listfilesout.ts

@@ -16,7 +16,7 @@ import {
 export type ListFilesOut = {
   data: Array<FileSchema>;
   object: string;
-  total: number;
+  total?: number | null | undefined;
 };
 
 /** @internal */
@@ -27,14 +27,14 @@ export const ListFilesOut$inboundSchema: z.ZodType<
 > = z.object({
   data: z.array(FileSchema$inboundSchema),
   object: z.string(),
-  total: z.number().int(),
+  total: z.nullable(z.number().int()).optional(),
 });
 
 /** @internal */
 export type ListFilesOut$Outbound = {
   data: Array<FileSchema$Outbound>;
   object: string;
-  total: number;
+  total?: number | null | undefined;
 };
 
 /** @internal */
@@ -45,7 +45,7 @@ export const ListFilesOut$outboundSchema: z.ZodType<
 > = z.object({
   data: z.array(FileSchema$outboundSchema),
   object: z.string(),
-  total: z.number().int(),
+  total: z.nullable(z.number().int()).optional(),
 });
 
 /**

package/src/models/components/modelcapabilities.ts

@@ -10,11 +10,14 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ModelCapabilities = {
   completionChat?: boolean | undefined;
-  completionFim?: boolean | undefined;
   functionCalling?: boolean | undefined;
+  completionFim?: boolean | undefined;
   fineTuning?: boolean | undefined;
   vision?: boolean | undefined;
+  ocr?: boolean | undefined;
   classification?: boolean | undefined;
+  moderation?: boolean | undefined;
+  audio?: boolean | undefined;
 };
 
 /** @internal */
@@ -23,17 +26,20 @@ export const ModelCapabilities$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  completion_chat: z.boolean().default(true),
+  completion_chat: z.boolean().default(false),
+  function_calling: z.boolean().default(false),
   completion_fim: z.boolean().default(false),
-  function_calling: z.boolean().default(true),
   fine_tuning: z.boolean().default(false),
   vision: z.boolean().default(false),
+  ocr: z.boolean().default(false),
   classification: z.boolean().default(false),
+  moderation: z.boolean().default(false),
+  audio: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     "completion_chat": "completionChat",
-    "completion_fim": "completionFim",
     "function_calling": "functionCalling",
+    "completion_fim": "completionFim",
     "fine_tuning": "fineTuning",
   });
 });
@@ -41,11 +47,14 @@ export const ModelCapabilities$inboundSchema: z.ZodType<
 /** @internal */
 export type ModelCapabilities$Outbound = {
   completion_chat: boolean;
-  completion_fim: boolean;
   function_calling: boolean;
+  completion_fim: boolean;
   fine_tuning: boolean;
   vision: boolean;
+  ocr: boolean;
   classification: boolean;
+  moderation: boolean;
+  audio: boolean;
 };
 
 /** @internal */
@@ -54,17 +63,20 @@ export const ModelCapabilities$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ModelCapabilities
 > = z.object({
-  completionChat: z.boolean().default(true),
+  completionChat: z.boolean().default(false),
+  functionCalling: z.boolean().default(false),
   completionFim: z.boolean().default(false),
-  functionCalling: z.boolean().default(true),
   fineTuning: z.boolean().default(false),
   vision: z.boolean().default(false),
+  ocr: z.boolean().default(false),
   classification: z.boolean().default(false),
+  moderation: z.boolean().default(false),
+  audio: z.boolean().default(false),
 }).transform((v) => {
   return remap$(v, {
     completionChat: "completion_chat",
-    completionFim: "completion_fim",
     functionCalling: "function_calling",
+    completionFim: "completion_fim",
     fineTuning: "fine_tuning",
   });
 });

package/src/models/components/modelconversation.ts

@@ -96,6 +96,10 @@ export type ModelConversation = {
    * Description of the what the conversation is about.
    */
   description?: string | null | undefined;
+  /**
+   * Custom metadata for the conversation.
+   */
+  metadata?: { [k: string]: any } | null | undefined;
   object?: ModelConversationObject | undefined;
   id: string;
   createdAt: Date;
@@ -284,6 +288,7 @@ export const ModelConversation$inboundSchema: z.ZodType<
   completion_args: CompletionArgs$inboundSchema.optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   object: ModelConversationObject$inboundSchema.default("conversation"),
   id: z.string(),
   created_at: z.string().datetime({ offset: true }).transform(v => new Date(v)),
@@ -313,6 +318,7 @@ export type ModelConversation$Outbound = {
   completion_args?: CompletionArgs$Outbound | undefined;
   name?: string | null | undefined;
   description?: string | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   object: string;
   id: string;
   created_at: string;
@@ -364,6 +370,7 @@ export const ModelConversation$outboundSchema: z.ZodType<
   completionArgs: CompletionArgs$outboundSchema.optional(),
   name: z.nullable(z.string()).optional(),
   description: z.nullable(z.string()).optional(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   object: ModelConversationObject$outboundSchema.default("conversation"),
   id: z.string(),
   createdAt: z.date().transform(v => v.toISOString()),

package/src/models/components/ocrpageobject.ts

@@ -18,6 +18,12 @@ import {
   OCRPageDimensions$Outbound,
   OCRPageDimensions$outboundSchema,
 } from "./ocrpagedimensions.js";
+import {
+  OCRTableObject,
+  OCRTableObject$inboundSchema,
+  OCRTableObject$Outbound,
+  OCRTableObject$outboundSchema,
+} from "./ocrtableobject.js";
 
 export type OCRPageObject = {
   /**
@@ -32,6 +38,22 @@ export type OCRPageObject = {
    * List of all extracted images in the page
    */
   images: Array<OCRImageObject>;
+  /**
+   * List of all extracted tables in the page
+   */
+  tables?: Array<OCRTableObject> | undefined;
+  /**
+   * List of all hyperlinks in the page
+   */
+  hyperlinks?: Array<string> | undefined;
+  /**
+   * Header of the page
+   */
+  header?: string | null | undefined;
+  /**
+   * Footer of the page
+   */
+  footer?: string | null | undefined;
   /**
    * The dimensions of the PDF Page's screenshot image
    */
@@ -47,6 +69,10 @@ export const OCRPageObject$inboundSchema: z.ZodType<
   index: z.number().int(),
   markdown: z.string(),
   images: z.array(OCRImageObject$inboundSchema),
+  tables: z.array(OCRTableObject$inboundSchema).optional(),
+  hyperlinks: z.array(z.string()).optional(),
+  header: z.nullable(z.string()).optional(),
+  footer: z.nullable(z.string()).optional(),
   dimensions: z.nullable(OCRPageDimensions$inboundSchema),
 });
 
@@ -55,6 +81,10 @@ export type OCRPageObject$Outbound = {
   index: number;
   markdown: string;
   images: Array<OCRImageObject$Outbound>;
+  tables?: Array<OCRTableObject$Outbound> | undefined;
+  hyperlinks?: Array<string> | undefined;
+  header?: string | null | undefined;
+  footer?: string | null | undefined;
   dimensions: OCRPageDimensions$Outbound | null;
 };
 
@@ -67,6 +97,10 @@ export const OCRPageObject$outboundSchema: z.ZodType<
   index: z.number().int(),
   markdown: z.string(),
   images: z.array(OCRImageObject$outboundSchema),
+  tables: z.array(OCRTableObject$outboundSchema).optional(),
+  hyperlinks: z.array(z.string()).optional(),
+  header: z.nullable(z.string()).optional(),
+  footer: z.nullable(z.string()).optional(),
   dimensions: z.nullable(OCRPageDimensions$outboundSchema),
 });