@mistralai/mistralai 1.9.19 → 1.11.0

package/src/models/components/ocrrequest.ts

@@ -5,6 +5,7 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
@@ -35,7 +36,13 @@ import {
 /**
  * Document to run OCR on
  */
-export type Document = FileChunk | ImageURLChunk | DocumentURLChunk;
+export type Document = FileChunk | DocumentURLChunk | ImageURLChunk;
+
+export const TableFormat = {
+  Markdown: "markdown",
+  Html: "html",
+} as const;
+export type TableFormat = ClosedEnum<typeof TableFormat>;
 
 export type OCRRequest = {
   model: string | null;
@@ -43,7 +50,7 @@ export type OCRRequest = {
   /**
    * Document to run OCR on
    */
-  document: FileChunk | ImageURLChunk | DocumentURLChunk;
+  document: FileChunk | DocumentURLChunk | ImageURLChunk;
   /**
    * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0
    */
@@ -68,6 +75,9 @@ export type OCRRequest = {
    * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
    */
   documentAnnotationFormat?: ResponseFormat | null | undefined;
+  tableFormat?: TableFormat | null | undefined;
+  extractHeader?: boolean | undefined;
+  extractFooter?: boolean | undefined;
 };
 
 /** @internal */
@@ -77,15 +87,15 @@ export const Document$inboundSchema: z.ZodType<
   unknown
 > = z.union([
   FileChunk$inboundSchema,
-  ImageURLChunk$inboundSchema,
   DocumentURLChunk$inboundSchema,
+  ImageURLChunk$inboundSchema,
 ]);
 
 /** @internal */
 export type Document$Outbound =
   | FileChunk$Outbound
-  | ImageURLChunk$Outbound
-  | DocumentURLChunk$Outbound;
+  | DocumentURLChunk$Outbound
+  | ImageURLChunk$Outbound;
 
 /** @internal */
 export const Document$outboundSchema: z.ZodType<
@@ -94,8 +104,8 @@ export const Document$outboundSchema: z.ZodType<
   Document
 > = z.union([
   FileChunk$outboundSchema,
-  ImageURLChunk$outboundSchema,
   DocumentURLChunk$outboundSchema,
+  ImageURLChunk$outboundSchema,
 ]);
 
 /**
@@ -125,6 +135,25 @@ export function documentFromJSON(
   );
 }
 
+/** @internal */
+export const TableFormat$inboundSchema: z.ZodNativeEnum<typeof TableFormat> = z
+  .nativeEnum(TableFormat);
+
+/** @internal */
+export const TableFormat$outboundSchema: z.ZodNativeEnum<typeof TableFormat> =
+  TableFormat$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TableFormat$ {
+  /** @deprecated use `TableFormat$inboundSchema` instead. */
+  export const inboundSchema = TableFormat$inboundSchema;
+  /** @deprecated use `TableFormat$outboundSchema` instead. */
+  export const outboundSchema = TableFormat$outboundSchema;
+}
+
 /** @internal */
 export const OCRRequest$inboundSchema: z.ZodType<
   OCRRequest,
@@ -135,8 +164,8 @@ export const OCRRequest$inboundSchema: z.ZodType<
   id: z.string().optional(),
   document: z.union([
     FileChunk$inboundSchema,
-    ImageURLChunk$inboundSchema,
     DocumentURLChunk$inboundSchema,
+    ImageURLChunk$inboundSchema,
   ]),
   pages: z.nullable(z.array(z.number().int())).optional(),
   include_image_base64: z.nullable(z.boolean()).optional(),
@@ -145,6 +174,9 @@ export const OCRRequest$inboundSchema: z.ZodType<
   bbox_annotation_format: z.nullable(ResponseFormat$inboundSchema).optional(),
   document_annotation_format: z.nullable(ResponseFormat$inboundSchema)
     .optional(),
+  table_format: z.nullable(TableFormat$inboundSchema).optional(),
+  extract_header: z.boolean().optional(),
+  extract_footer: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     "include_image_base64": "includeImageBase64",
@@ -152,6 +184,9 @@ export const OCRRequest$inboundSchema: z.ZodType<
     "image_min_size": "imageMinSize",
     "bbox_annotation_format": "bboxAnnotationFormat",
     "document_annotation_format": "documentAnnotationFormat",
+    "table_format": "tableFormat",
+    "extract_header": "extractHeader",
+    "extract_footer": "extractFooter",
   });
 });
 
@@ -161,14 +196,17 @@ export type OCRRequest$Outbound = {
   id?: string | undefined;
   document:
     | FileChunk$Outbound
-    | ImageURLChunk$Outbound
-    | DocumentURLChunk$Outbound;
+    | DocumentURLChunk$Outbound
+    | ImageURLChunk$Outbound;
   pages?: Array<number> | null | undefined;
   include_image_base64?: boolean | null | undefined;
   image_limit?: number | null | undefined;
   image_min_size?: number | null | undefined;
   bbox_annotation_format?: ResponseFormat$Outbound | null | undefined;
   document_annotation_format?: ResponseFormat$Outbound | null | undefined;
+  table_format?: string | null | undefined;
+  extract_header?: boolean | undefined;
+  extract_footer?: boolean | undefined;
 };
 
 /** @internal */
@@ -181,8 +219,8 @@ export const OCRRequest$outboundSchema: z.ZodType<
   id: z.string().optional(),
   document: z.union([
     FileChunk$outboundSchema,
-    ImageURLChunk$outboundSchema,
     DocumentURLChunk$outboundSchema,
+    ImageURLChunk$outboundSchema,
   ]),
   pages: z.nullable(z.array(z.number().int())).optional(),
   includeImageBase64: z.nullable(z.boolean()).optional(),
@@ -191,6 +229,9 @@ export const OCRRequest$outboundSchema: z.ZodType<
   bboxAnnotationFormat: z.nullable(ResponseFormat$outboundSchema).optional(),
   documentAnnotationFormat: z.nullable(ResponseFormat$outboundSchema)
     .optional(),
+  tableFormat: z.nullable(TableFormat$outboundSchema).optional(),
+  extractHeader: z.boolean().optional(),
+  extractFooter: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     includeImageBase64: "include_image_base64",
@@ -198,6 +239,9 @@ export const OCRRequest$outboundSchema: z.ZodType<
     imageMinSize: "image_min_size",
     bboxAnnotationFormat: "bbox_annotation_format",
     documentAnnotationFormat: "document_annotation_format",
+    tableFormat: "table_format",
+    extractHeader: "extract_header",
+    extractFooter: "extract_footer",
   });
 });
 

package/src/models/components/ocrtableobject.ts

@@ -0,0 +1,111 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Format of the table
+ */
+export const Format = {
+  Markdown: "markdown",
+  Html: "html",
+} as const;
+/**
+ * Format of the table
+ */
+export type Format = ClosedEnum<typeof Format>;
+
+export type OCRTableObject = {
+  /**
+   * Table ID for extracted table in a page
+   */
+  id: string;
+  /**
+   * Content of the table in the given format
+   */
+  content: string;
+  /**
+   * Format of the table
+   */
+  format: Format;
+};
+
+/** @internal */
+export const Format$inboundSchema: z.ZodNativeEnum<typeof Format> = z
+  .nativeEnum(Format);
+
+/** @internal */
+export const Format$outboundSchema: z.ZodNativeEnum<typeof Format> =
+  Format$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Format$ {
+  /** @deprecated use `Format$inboundSchema` instead. */
+  export const inboundSchema = Format$inboundSchema;
+  /** @deprecated use `Format$outboundSchema` instead. */
+  export const outboundSchema = Format$outboundSchema;
+}
+
+/** @internal */
+export const OCRTableObject$inboundSchema: z.ZodType<
+  OCRTableObject,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  content: z.string(),
+  format: Format$inboundSchema,
+});
+
+/** @internal */
+export type OCRTableObject$Outbound = {
+  id: string;
+  content: string;
+  format: string;
+};
+
+/** @internal */
+export const OCRTableObject$outboundSchema: z.ZodType<
+  OCRTableObject$Outbound,
+  z.ZodTypeDef,
+  OCRTableObject
+> = z.object({
+  id: z.string(),
+  content: z.string(),
+  format: Format$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRTableObject$ {
+  /** @deprecated use `OCRTableObject$inboundSchema` instead. */
+  export const inboundSchema = OCRTableObject$inboundSchema;
+  /** @deprecated use `OCRTableObject$outboundSchema` instead. */
+  export const outboundSchema = OCRTableObject$outboundSchema;
+  /** @deprecated use `OCRTableObject$Outbound` instead. */
+  export type Outbound = OCRTableObject$Outbound;
+}
+
+export function ocrTableObjectToJSON(ocrTableObject: OCRTableObject): string {
+  return JSON.stringify(OCRTableObject$outboundSchema.parse(ocrTableObject));
+}
+
+export function ocrTableObjectFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRTableObject, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRTableObject$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRTableObject' from JSON`,
+  );
+}

package/src/models/components/outputcontentchunks.ts

@@ -44,12 +44,12 @@ import {
 } from "./toolreferencechunk.js";
 
 export type OutputContentChunks =
+  | ToolFileChunk
+  | ToolReferenceChunk
   | TextChunk
   | ImageURLChunk
   | DocumentURLChunk
-  | ThinkChunk
-  | ToolFileChunk
-  | ToolReferenceChunk;
+  | ThinkChunk;
 
 /** @internal */
 export const OutputContentChunks$inboundSchema: z.ZodType<
@@ -57,22 +57,22 @@ export const OutputContentChunks$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.union([
+  ToolFileChunk$inboundSchema,
+  ToolReferenceChunk$inboundSchema,
   TextChunk$inboundSchema,
   ImageURLChunk$inboundSchema,
   DocumentURLChunk$inboundSchema,
   ThinkChunk$inboundSchema,
-  ToolFileChunk$inboundSchema,
-  ToolReferenceChunk$inboundSchema,
 ]);
 
 /** @internal */
 export type OutputContentChunks$Outbound =
+  | ToolFileChunk$Outbound
+  | ToolReferenceChunk$Outbound
   | TextChunk$Outbound
   | ImageURLChunk$Outbound
   | DocumentURLChunk$Outbound
-  | ThinkChunk$Outbound
-  | ToolFileChunk$Outbound
-  | ToolReferenceChunk$Outbound;
+  | ThinkChunk$Outbound;
 
 /** @internal */
 export const OutputContentChunks$outboundSchema: z.ZodType<
@@ -80,12 +80,12 @@ export const OutputContentChunks$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   OutputContentChunks
 > = z.union([
+  ToolFileChunk$outboundSchema,
+  ToolReferenceChunk$outboundSchema,
   TextChunk$outboundSchema,
   ImageURLChunk$outboundSchema,
   DocumentURLChunk$outboundSchema,
   ThinkChunk$outboundSchema,
-  ToolFileChunk$outboundSchema,
-  ToolReferenceChunk$outboundSchema,
 ]);
 
 /**

package/src/models/components/prediction.ts

@@ -7,6 +7,9 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
+/**
+ * Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
+ */
 export type Prediction = {
   type?: "content" | undefined;
   content?: string | undefined;

package/src/models/components/requestsource.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+export const RequestSource = {
+  Api: "api",
+  Playground: "playground",
+  AgentBuilderV1: "agent_builder_v1",
+} as const;
+export type RequestSource = ClosedEnum<typeof RequestSource>;
+
+/** @internal */
+export const RequestSource$inboundSchema: z.ZodNativeEnum<
+  typeof RequestSource
+> = z.nativeEnum(RequestSource);
+
+/** @internal */
+export const RequestSource$outboundSchema: z.ZodNativeEnum<
+  typeof RequestSource
+> = RequestSource$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace RequestSource$ {
+  /** @deprecated use `RequestSource$inboundSchema` instead. */
+  export const inboundSchema = RequestSource$inboundSchema;
+  /** @deprecated use `RequestSource$outboundSchema` instead. */
+  export const outboundSchema = RequestSource$outboundSchema;
+}

package/src/models/components/responseformat.ts

@@ -19,10 +19,10 @@ import {
   ResponseFormats$outboundSchema,
 } from "./responseformats.js";
 
+/**
+ * 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.
+ */
 export type ResponseFormat = {
-  /**
-   * An object specifying the format that the model must output. 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.
-   */
   type?: ResponseFormats | undefined;
   jsonSchema?: JsonSchema | null | undefined;
 };

package/src/models/components/responseformats.ts

@@ -5,17 +5,11 @@
 import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
-/**
- * An object specifying the format that the model must output. 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.
- */
 export const ResponseFormats = {
   Text: "text",
   JsonObject: "json_object",
   JsonSchema: "json_schema",
 } as const;
-/**
- * An object specifying the format that the model must output. 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.
- */
 export type ResponseFormats = ClosedEnum<typeof ResponseFormats>;
 
 /** @internal */

package/src/models/components/sharingdelete.ts

@@ -14,7 +14,7 @@ import {
 } from "./entitytype.js";
 
 export type SharingDelete = {
-  orgId: string;
+  orgId?: string | null | undefined;
   /**
    * The id of the entity (user, workspace or organization) to share with
    */
@@ -31,7 +31,7 @@ export const SharingDelete$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  org_id: z.string(),
+  org_id: z.nullable(z.string()).optional(),
   share_with_uuid: z.string(),
   share_with_type: EntityType$inboundSchema,
 }).transform((v) => {
@@ -44,7 +44,7 @@ export const SharingDelete$inboundSchema: z.ZodType<
 
 /** @internal */
 export type SharingDelete$Outbound = {
-  org_id: string;
+  org_id?: string | null | undefined;
   share_with_uuid: string;
   share_with_type: string;
 };
@@ -55,7 +55,7 @@ export const SharingDelete$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SharingDelete
 > = z.object({
-  orgId: z.string(),
+  orgId: z.nullable(z.string()).optional(),
   shareWithUuid: z.string(),
   shareWithType: EntityType$outboundSchema,
 }).transform((v) => {

package/src/models/components/sharingin.ts

@@ -19,7 +19,7 @@ import {
 } from "./shareenum.js";
 
 export type SharingIn = {
-  orgId: string;
+  orgId?: string | null | undefined;
   level: ShareEnum;
   /**
    * The id of the entity (user, workspace or organization) to share with
@@ -37,7 +37,7 @@ export const SharingIn$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  org_id: z.string(),
+  org_id: z.nullable(z.string()).optional(),
   level: ShareEnum$inboundSchema,
   share_with_uuid: z.string(),
   share_with_type: EntityType$inboundSchema,
@@ -51,7 +51,7 @@ export const SharingIn$inboundSchema: z.ZodType<
 
 /** @internal */
 export type SharingIn$Outbound = {
-  org_id: string;
+  org_id?: string | null | undefined;
   level: string;
   share_with_uuid: string;
   share_with_type: string;
@@ -63,7 +63,7 @@ export const SharingIn$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   SharingIn
 > = z.object({
-  orgId: z.string(),
+  orgId: z.nullable(z.string()).optional(),
   level: ShareEnum$outboundSchema,
   shareWithUuid: z.string(),
   shareWithType: EntityType$outboundSchema,

package/src/models/components/sharingout.ts

@@ -14,7 +14,7 @@ export type SharingOut = {
   orgId: string;
   role: string;
   shareWithType: string;
-  shareWithUuid: string;
+  shareWithUuid: string | null;
 };
 
 /** @internal */
@@ -28,7 +28,7 @@ export const SharingOut$inboundSchema: z.ZodType<
   org_id: z.string(),
   role: z.string(),
   share_with_type: z.string(),
-  share_with_uuid: z.string(),
+  share_with_uuid: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     "library_id": "libraryId",
@@ -46,7 +46,7 @@ export type SharingOut$Outbound = {
   org_id: string;
   role: string;
   share_with_type: string;
-  share_with_uuid: string;
+  share_with_uuid: string | null;
 };
 
 /** @internal */
@@ -60,7 +60,7 @@ export const SharingOut$outboundSchema: z.ZodType<
   orgId: z.string(),
   role: z.string(),
   shareWithType: z.string(),
-  shareWithUuid: z.string(),
+  shareWithUuid: z.nullable(z.string()),
 }).transform((v) => {
   return remap$(v, {
     libraryId: "library_id",

package/src/models/components/toolexecutiondeltaevent.ts

@@ -21,12 +21,14 @@ export type ToolExecutionDeltaEventType = ClosedEnum<
   typeof ToolExecutionDeltaEventType
 >;
 
+export type ToolExecutionDeltaEventName = BuiltInConnectors | string;
+
 export type ToolExecutionDeltaEvent = {
   type?: ToolExecutionDeltaEventType | undefined;
   createdAt?: Date | undefined;
   outputIndex?: number | undefined;
   id: string;
-  name: BuiltInConnectors;
+  name: BuiltInConnectors | string;
   arguments: string;
 };
 
@@ -51,6 +53,56 @@ export namespace ToolExecutionDeltaEventType$ {
   export const outboundSchema = ToolExecutionDeltaEventType$outboundSchema;
 }
 
+/** @internal */
+export const ToolExecutionDeltaEventName$inboundSchema: z.ZodType<
+  ToolExecutionDeltaEventName,
+  z.ZodTypeDef,
+  unknown
+> = z.union([BuiltInConnectors$inboundSchema, z.string()]);
+
+/** @internal */
+export type ToolExecutionDeltaEventName$Outbound = string | string;
+
+/** @internal */
+export const ToolExecutionDeltaEventName$outboundSchema: z.ZodType<
+  ToolExecutionDeltaEventName$Outbound,
+  z.ZodTypeDef,
+  ToolExecutionDeltaEventName
+> = z.union([BuiltInConnectors$outboundSchema, z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ToolExecutionDeltaEventName$ {
+  /** @deprecated use `ToolExecutionDeltaEventName$inboundSchema` instead. */
+  export const inboundSchema = ToolExecutionDeltaEventName$inboundSchema;
+  /** @deprecated use `ToolExecutionDeltaEventName$outboundSchema` instead. */
+  export const outboundSchema = ToolExecutionDeltaEventName$outboundSchema;
+  /** @deprecated use `ToolExecutionDeltaEventName$Outbound` instead. */
+  export type Outbound = ToolExecutionDeltaEventName$Outbound;
+}
+
+export function toolExecutionDeltaEventNameToJSON(
+  toolExecutionDeltaEventName: ToolExecutionDeltaEventName,
+): string {
+  return JSON.stringify(
+    ToolExecutionDeltaEventName$outboundSchema.parse(
+      toolExecutionDeltaEventName,
+    ),
+  );
+}
+
+export function toolExecutionDeltaEventNameFromJSON(
+  jsonString: string,
+): SafeParseResult<ToolExecutionDeltaEventName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ToolExecutionDeltaEventName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolExecutionDeltaEventName' from JSON`,
+  );
+}
+
 /** @internal */
 export const ToolExecutionDeltaEvent$inboundSchema: z.ZodType<
   ToolExecutionDeltaEvent,
@@ -64,7 +116,7 @@ export const ToolExecutionDeltaEvent$inboundSchema: z.ZodType<
     .optional(),
   output_index: z.number().int().default(0),
   id: z.string(),
-  name: BuiltInConnectors$inboundSchema,
+  name: z.union([BuiltInConnectors$inboundSchema, z.string()]),
   arguments: z.string(),
 }).transform((v) => {
   return remap$(v, {
@@ -79,7 +131,7 @@ export type ToolExecutionDeltaEvent$Outbound = {
   created_at?: string | undefined;
   output_index: number;
   id: string;
-  name: string;
+  name: string | string;
   arguments: string;
 };
 
@@ -95,7 +147,7 @@ export const ToolExecutionDeltaEvent$outboundSchema: z.ZodType<
   createdAt: z.date().transform(v => v.toISOString()).optional(),
   outputIndex: z.number().int().default(0),
   id: z.string(),
-  name: BuiltInConnectors$outboundSchema,
+  name: z.union([BuiltInConnectors$outboundSchema, z.string()]),
   arguments: z.string(),
 }).transform((v) => {
   return remap$(v, {