@mistralai/mistralai 1.10.0 → 1.12.0

package/src/models/components/audioencoding.ts

@@ -0,0 +1,52 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import {
+  catchUnrecognizedEnum,
+  OpenEnum,
+  Unrecognized,
+} from "../../types/enums.js";
+
+export const AudioEncoding = {
+  PcmS16le: "pcm_s16le",
+  PcmS32le: "pcm_s32le",
+  PcmF16le: "pcm_f16le",
+  PcmF32le: "pcm_f32le",
+  PcmMulaw: "pcm_mulaw",
+  PcmAlaw: "pcm_alaw",
+} as const;
+export type AudioEncoding = OpenEnum<typeof AudioEncoding>;
+
+/** @internal */
+export const AudioEncoding$inboundSchema: z.ZodType<
+  AudioEncoding,
+  z.ZodTypeDef,
+  unknown
+> = z
+  .union([
+    z.nativeEnum(AudioEncoding),
+    z.string().transform(catchUnrecognizedEnum),
+  ]);
+
+/** @internal */
+export const AudioEncoding$outboundSchema: z.ZodType<
+  AudioEncoding,
+  z.ZodTypeDef,
+  AudioEncoding
+> = z.union([
+  z.nativeEnum(AudioEncoding),
+  z.string().and(z.custom<Unrecognized<string>>()),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AudioEncoding$ {
+  /** @deprecated use `AudioEncoding$inboundSchema` instead. */
+  export const inboundSchema = AudioEncoding$inboundSchema;
+  /** @deprecated use `AudioEncoding$outboundSchema` instead. */
+  export const outboundSchema = AudioEncoding$outboundSchema;
+}

package/src/models/components/audioformat.ts

@@ -0,0 +1,80 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AudioEncoding,
+  AudioEncoding$inboundSchema,
+  AudioEncoding$outboundSchema,
+} from "./audioencoding.js";
+
+export type AudioFormat = {
+  encoding: AudioEncoding;
+  sampleRate: number;
+};
+
+/** @internal */
+export const AudioFormat$inboundSchema: z.ZodType<
+  AudioFormat,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  encoding: AudioEncoding$inboundSchema,
+  sample_rate: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    "sample_rate": "sampleRate",
+  });
+});
+
+/** @internal */
+export type AudioFormat$Outbound = {
+  encoding: string;
+  sample_rate: number;
+};
+
+/** @internal */
+export const AudioFormat$outboundSchema: z.ZodType<
+  AudioFormat$Outbound,
+  z.ZodTypeDef,
+  AudioFormat
+> = z.object({
+  encoding: AudioEncoding$outboundSchema,
+  sampleRate: z.number().int(),
+}).transform((v) => {
+  return remap$(v, {
+    sampleRate: "sample_rate",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace AudioFormat$ {
+  /** @deprecated use `AudioFormat$inboundSchema` instead. */
+  export const inboundSchema = AudioFormat$inboundSchema;
+  /** @deprecated use `AudioFormat$outboundSchema` instead. */
+  export const outboundSchema = AudioFormat$outboundSchema;
+  /** @deprecated use `AudioFormat$Outbound` instead. */
+  export type Outbound = AudioFormat$Outbound;
+}
+
+export function audioFormatToJSON(audioFormat: AudioFormat): string {
+  return JSON.stringify(AudioFormat$outboundSchema.parse(audioFormat));
+}
+
+export function audioFormatFromJSON(
+  jsonString: string,
+): SafeParseResult<AudioFormat, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AudioFormat$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AudioFormat' from JSON`,
+  );
+}

package/src/models/components/audiotranscriptionrequest.ts

@@ -21,6 +21,9 @@ import {
 } from "./timestampgranularity.js";
 
 export type AudioTranscriptionRequest = {
+  /**
+   * ID of the model to be used.
+   */
   model: string;
   file?: FileT | Blob | undefined;
   /**

package/src/models/components/batchjobin.ts

@@ -12,13 +12,35 @@ import {
   ApiEndpoint$inboundSchema,
   ApiEndpoint$outboundSchema,
 } from "./apiendpoint.js";
+import {
+  BatchRequest,
+  BatchRequest$inboundSchema,
+  BatchRequest$Outbound,
+  BatchRequest$outboundSchema,
+} from "./batchrequest.js";
 
 export type BatchJobIn = {
-  inputFiles: Array<string>;
+  /**
+   * The list of input files to be used for batch inference, these files should be `jsonl` files, containing the input data corresponding to the bory request for the batch inference in a "body" field. An example of such file is the following: ```json {"custom_id": "0", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French cheese?"}]}} {"custom_id": "1", "body": {"max_tokens": 100, "messages": [{"role": "user", "content": "What is the best French wine?"}]}} ```
+   */
+  inputFiles?: Array<string> | null | undefined;
+  requests?: Array<BatchRequest> | null | undefined;
   endpoint: ApiEndpoint;
+  /**
+   * The model to be used for batch inference.
+   */
   model?: string | null | undefined;
+  /**
+   * In case you want to use a specific agent from the **deprecated** agents api for batch inference, you can specify the agent ID here.
+   */
   agentId?: string | null | undefined;
+  /**
+   * The metadata of your choice to be associated with the batch inference job.
+   */
   metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * The timeout in hours for the batch inference job.
+   */
   timeoutHours?: number | undefined;
 };
 
@@ -28,7 +50,8 @@ export const BatchJobIn$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  input_files: z.array(z.string()),
+  input_files: z.nullable(z.array(z.string())).optional(),
+  requests: z.nullable(z.array(BatchRequest$inboundSchema)).optional(),
   endpoint: ApiEndpoint$inboundSchema,
   model: z.nullable(z.string()).optional(),
   agent_id: z.nullable(z.string()).optional(),
@@ -44,7 +67,8 @@ export const BatchJobIn$inboundSchema: z.ZodType<
 
 /** @internal */
 export type BatchJobIn$Outbound = {
-  input_files: Array<string>;
+  input_files?: Array<string> | null | undefined;
+  requests?: Array<BatchRequest$Outbound> | null | undefined;
   endpoint: string;
   model?: string | null | undefined;
   agent_id?: string | null | undefined;
@@ -58,7 +82,8 @@ export const BatchJobIn$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   BatchJobIn
 > = z.object({
-  inputFiles: z.array(z.string()),
+  inputFiles: z.nullable(z.array(z.string())).optional(),
+  requests: z.nullable(z.array(BatchRequest$outboundSchema)).optional(),
   endpoint: ApiEndpoint$outboundSchema,
   model: z.nullable(z.string()).optional(),
   agentId: z.nullable(z.string()).optional(),

package/src/models/components/batchjobout.ts

@@ -36,6 +36,7 @@ export type BatchJobOut = {
   outputFile?: string | null | undefined;
   errorFile?: string | null | undefined;
   errors: Array<BatchError>;
+  outputs?: Array<{ [k: string]: any }> | null | undefined;
   status: BatchJobStatus;
   createdAt: number;
   totalRequests: number;
@@ -83,6 +84,7 @@ export const BatchJobOut$inboundSchema: z.ZodType<
   output_file: z.nullable(z.string()).optional(),
   error_file: z.nullable(z.string()).optional(),
   errors: z.array(BatchError$inboundSchema),
+  outputs: z.nullable(z.array(z.record(z.any()))).optional(),
   status: BatchJobStatus$inboundSchema,
   created_at: z.number().int(),
   total_requests: z.number().int(),
@@ -119,6 +121,7 @@ export type BatchJobOut$Outbound = {
   output_file?: string | null | undefined;
   error_file?: string | null | undefined;
   errors: Array<BatchError$Outbound>;
+  outputs?: Array<{ [k: string]: any }> | null | undefined;
   status: string;
   created_at: number;
   total_requests: number;
@@ -145,6 +148,7 @@ export const BatchJobOut$outboundSchema: z.ZodType<
   outputFile: z.nullable(z.string()).optional(),
   errorFile: z.nullable(z.string()).optional(),
   errors: z.array(BatchError$outboundSchema),
+  outputs: z.nullable(z.array(z.record(z.any()))).optional(),
   status: BatchJobStatus$outboundSchema,
   createdAt: z.number().int(),
   totalRequests: z.number().int(),

package/src/models/components/batchrequest.ts

@@ -0,0 +1,75 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type BatchRequest = {
+  customId?: string | null | undefined;
+  body: { [k: string]: any };
+};
+
+/** @internal */
+export const BatchRequest$inboundSchema: z.ZodType<
+  BatchRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  custom_id: z.nullable(z.string()).optional(),
+  body: z.record(z.any()),
+}).transform((v) => {
+  return remap$(v, {
+    "custom_id": "customId",
+  });
+});
+
+/** @internal */
+export type BatchRequest$Outbound = {
+  custom_id?: string | null | undefined;
+  body: { [k: string]: any };
+};
+
+/** @internal */
+export const BatchRequest$outboundSchema: z.ZodType<
+  BatchRequest$Outbound,
+  z.ZodTypeDef,
+  BatchRequest
+> = z.object({
+  customId: z.nullable(z.string()).optional(),
+  body: z.record(z.any()),
+}).transform((v) => {
+  return remap$(v, {
+    customId: "custom_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BatchRequest$ {
+  /** @deprecated use `BatchRequest$inboundSchema` instead. */
+  export const inboundSchema = BatchRequest$inboundSchema;
+  /** @deprecated use `BatchRequest$outboundSchema` instead. */
+  export const outboundSchema = BatchRequest$outboundSchema;
+  /** @deprecated use `BatchRequest$Outbound` instead. */
+  export type Outbound = BatchRequest$Outbound;
+}
+
+export function batchRequestToJSON(batchRequest: BatchRequest): string {
+  return JSON.stringify(BatchRequest$outboundSchema.parse(batchRequest));
+}
+
+export function batchRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<BatchRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => BatchRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BatchRequest' from JSON`,
+  );
+}

package/src/models/components/chatcompletionrequest.ts

@@ -77,6 +77,9 @@ export type Messages =
   | (UserMessage & { role: "user" })
   | (AssistantMessage & { role: "assistant" });
 
+/**
+ * Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
+ */
 export type ChatCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum;
 
 export type ChatCompletionRequest = {
@@ -108,6 +111,7 @@ export type ChatCompletionRequest = {
    * 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 prompt(s) to generate completions for, encoded as a list of dict with role and content.
    */
@@ -117,22 +121,37 @@ export type ChatCompletionRequest = {
     | (UserMessage & { role: "user" })
     | (AssistantMessage & { role: "assistant" })
   >;
+  /**
+   * 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.
+   */
   responseFormat?: ResponseFormat | undefined;
+  /**
+   * A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
+   */
   tools?: Array<Tool> | null | undefined;
+  /**
+   * Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
+   */
   toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
   /**
-   * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
+   * The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
    */
   presencePenalty?: number | undefined;
   /**
-   * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
+   * The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
    */
   frequencyPenalty?: number | undefined;
   /**
    * Number of completions to return for each request, input tokens are only billed once.
    */
   n?: number | null | undefined;
+  /**
+   * Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
+   */
   prediction?: Prediction | undefined;
+  /**
+   * Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
+   */
   parallelToolCalls?: boolean | undefined;
   /**
    * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
@@ -329,6 +348,7 @@ export const ChatCompletionRequest$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(),
   messages: z.array(
     z.union([
       SystemMessage$inboundSchema.and(
@@ -388,6 +408,7 @@ export type ChatCompletionRequest$Outbound = {
   stream: boolean;
   stop?: string | Array<string> | undefined;
   random_seed?: number | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   messages: Array<
     | (SystemMessage$Outbound & { role: "system" })
     | (ToolMessage$Outbound & { role: "tool" })
@@ -419,6 +440,7 @@ export const ChatCompletionRequest$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(),
   messages: z.array(
     z.union([
       SystemMessage$outboundSchema.and(

package/src/models/components/chatcompletionstreamrequest.ts

@@ -77,6 +77,9 @@ export type ChatCompletionStreamRequestMessages =
   | (UserMessage & { role: "user" })
   | (AssistantMessage & { role: "assistant" });
 
+/**
+ * Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
+ */
 export type ChatCompletionStreamRequestToolChoice = ToolChoice | ToolChoiceEnum;
 
 export type ChatCompletionStreamRequest = {
@@ -105,6 +108,7 @@ export type ChatCompletionStreamRequest = {
    * 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 prompt(s) to generate completions for, encoded as a list of dict with role and content.
    */
@@ -114,22 +118,37 @@ export type ChatCompletionStreamRequest = {
     | (UserMessage & { role: "user" })
     | (AssistantMessage & { role: "assistant" })
   >;
+  /**
+   * 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.
+   */
   responseFormat?: ResponseFormat | undefined;
+  /**
+   * A list of tools the model may call. Use this to provide a list of functions the model may generate JSON inputs for.
+   */
   tools?: Array<Tool> | null | undefined;
+  /**
+   * Controls which (if any) tool is called by the model. `none` means the model will not call any tool and instead generates a message. `auto` means the model can pick between generating a message or calling one or more tools. `any` or `required` means the model must call one or more tools. Specifying a particular tool via `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that tool.
+   */
   toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
   /**
-   * presence_penalty determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
+   * The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
    */
   presencePenalty?: number | undefined;
   /**
-   * frequency_penalty penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
+   * The `frequency_penalty` penalizes the repetition of words based on their frequency in the generated text. A higher frequency penalty discourages the model from repeating words that have already appeared frequently in the output, promoting diversity and reducing repetition.
    */
   frequencyPenalty?: number | undefined;
   /**
    * Number of completions to return for each request, input tokens are only billed once.
    */
   n?: number | null | undefined;
+  /**
+   * Enable users to specify an expected completion, optimizing response times by leveraging known or predictable content.
+   */
   prediction?: Prediction | undefined;
+  /**
+   * Whether to enable parallel function calling during tool use, when enabled the model can call multiple tools in parallel.
+   */
   parallelToolCalls?: boolean | undefined;
   /**
    * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
@@ -350,6 +369,7 @@ export const ChatCompletionStreamRequest$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(),
   messages: z.array(
     z.union([
       SystemMessage$inboundSchema.and(
@@ -409,6 +429,7 @@ export type ChatCompletionStreamRequest$Outbound = {
   stream: boolean;
   stop?: string | Array<string> | undefined;
   random_seed?: number | null | undefined;
+  metadata?: { [k: string]: any } | null | undefined;
   messages: Array<
     | (SystemMessage$Outbound & { role: "system" })
     | (ToolMessage$Outbound & { role: "tool" })
@@ -440,6 +461,7 @@ export const ChatCompletionStreamRequest$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(),
   messages: z.array(
     z.union([
       SystemMessage$outboundSchema.and(

package/src/models/components/classificationrequest.ts

@@ -18,6 +18,7 @@ export type ClassificationRequest = {
    * ID of the model to use.
    */
   model: string;
+  metadata?: { [k: string]: any } | null | undefined;
   /**
    * Text to classify.
    */
@@ -81,6 +82,7 @@ export const ClassificationRequest$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   model: z.string(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   input: z.union([z.string(), z.array(z.string())]),
 }).transform((v) => {
   return remap$(v, {
@@ -91,6 +93,7 @@ export const ClassificationRequest$inboundSchema: z.ZodType<
 /** @internal */
 export type ClassificationRequest$Outbound = {
   model: string;
+  metadata?: { [k: string]: any } | null | undefined;
   input: string | Array<string>;
 };
 
@@ -101,6 +104,7 @@ export const ClassificationRequest$outboundSchema: z.ZodType<
   ClassificationRequest
 > = z.object({
   model: z.string(),
+  metadata: z.nullable(z.record(z.any())).optional(),
   inputs: z.union([z.string(), z.array(z.string())]),
 }).transform((v) => {
   return remap$(v, {