@mistralai/mistralai 1.13.0 → 1.14.1

package/README.md

@@ -101,9 +101,9 @@ async function run() {
     model: "mistral-large-latest",
     messages: [
       {
+        role: "user",
         content:
           "Who is the best French painter? Answer in one short sentence.",
-        role: "user",
       },
     ],
     responseFormat: {
@@ -157,9 +157,9 @@ async function run() {
   const result = await mistral.agents.complete({
     messages: [
       {
+        role: "user",
         content:
           "Who is the best French painter? Answer in one short sentence.",
-        role: "user",
       },
     ],
     agentId: "<id>",
@@ -240,6 +240,9 @@ We have dedicated SDKs for the following providers:
 * [updateVersion](docs/sdks/mistralagents/README.md#updateversion) - Update an agent version.
 * [listVersions](docs/sdks/mistralagents/README.md#listversions) - List all versions of an agent.
 * [getVersion](docs/sdks/mistralagents/README.md#getversion) - Retrieve a specific version of an agent.
+* [createVersionAlias](docs/sdks/mistralagents/README.md#createversionalias) - Create or update an agent version alias.
+* [listVersionAliases](docs/sdks/mistralagents/README.md#listversionaliases) - List all aliases for an agent.
+* [deleteVersionAlias](docs/sdks/mistralagents/README.md#deleteversionalias) - Delete an agent version alias.
 
 ### [Beta.Conversations](docs/sdks/conversations/README.md)
 
@@ -552,7 +555,7 @@ run();
 
 
 **Inherit from [`MistralError`](./src/models/errors/mistralerror.ts)**:
-* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 50 of 72 methods.*
+* [`HTTPValidationError`](./src/models/errors/httpvalidationerror.ts): Validation Error. Status code `422`. Applicable to 53 of 75 methods.*
 * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): Type mismatch between the data returned from the server and the structure expected by the SDK. See `error.rawValue` for the raw value and `error.pretty()` for a nicely formatted multi-line string.
 
 </details>
@@ -723,10 +726,13 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`batchJobsGet`](docs/sdks/mistraljobs/README.md#get) - Get Batch Job
 - [`batchJobsList`](docs/sdks/mistraljobs/README.md#list) - Get Batch Jobs
 - [`betaAgentsCreate`](docs/sdks/mistralagents/README.md#create) - Create a agent that can be used within a conversation.
+- [`betaAgentsCreateVersionAlias`](docs/sdks/mistralagents/README.md#createversionalias) - Create or update an agent version alias.
 - [`betaAgentsDelete`](docs/sdks/mistralagents/README.md#delete) - Delete an agent entity.
+- [`betaAgentsDeleteVersionAlias`](docs/sdks/mistralagents/README.md#deleteversionalias) - Delete an agent version alias.
 - [`betaAgentsGet`](docs/sdks/mistralagents/README.md#get) - Retrieve an agent entity.
 - [`betaAgentsGetVersion`](docs/sdks/mistralagents/README.md#getversion) - Retrieve a specific version of an agent.
 - [`betaAgentsList`](docs/sdks/mistralagents/README.md#list) - List agent entities.
+- [`betaAgentsListVersionAliases`](docs/sdks/mistralagents/README.md#listversionaliases) - List all aliases for an agent.
 - [`betaAgentsListVersions`](docs/sdks/mistralagents/README.md#listversions) - List all versions of an agent.
 - [`betaAgentsUpdate`](docs/sdks/mistralagents/README.md#update) - Update an agent entity.
 - [`betaAgentsUpdateVersion`](docs/sdks/mistralagents/README.md#updateversion) - Update an agent version.

package/examples/src/async_audio_transcription_diarize.ts

@@ -0,0 +1,17 @@
+import { Mistral } from "@mistralai/mistralai";
+
+const apiKey = process.env["MISTRAL_API_KEY"];
+if (!apiKey) {
+  throw new Error("missing MISTRAL_API_KEY environment variable");
+}
+
+const mistral = new Mistral({ apiKey: apiKey });
+
+const response = await mistral.audio.transcriptions.complete({
+  model: "voxtral-mini-2602",
+  fileUrl: "https://docs.mistral.ai/audio/bcn_weather.mp3",
+  diarize: true,
+  timestampGranularities: ["segment"],
+});
+
+process.stdout.write(JSON.stringify(response));

package/examples/src/realtime_microphone.ts

@@ -0,0 +1,163 @@
+import { spawn, type ChildProcess } from "node:child_process";
+import yargs from "yargs/yargs";
+import { hideBin } from "yargs/helpers";
+
+import {
+  AudioEncoding,
+  RealtimeTranscription,
+} from "@mistralai/mistralai/extra/realtime";
+
+type Args = {
+  model: string;
+  encoding: string;
+  sampleRate: number;
+  apiKey?: string;
+  baseUrl: string;
+};
+
+function parseArgs(): Args {
+  const argv = yargs(hideBin(process.argv))
+    .usage("Usage: $0 [options]")
+    .option("model", {
+      type: "string",
+      default: "voxtral-mini-transcribe-realtime-2602",
+      describe: "Model ID",
+    })
+    .option("encoding", {
+      type: "string",
+      default: AudioEncoding.PcmS16le,
+      describe: "Audio encoding",
+    })
+    .option("sample-rate", {
+      type: "number",
+      default: 16000,
+      describe: "Sample rate in Hz",
+    })
+    .option("api-key", {
+      type: "string",
+      default: process.env["MISTRAL_API_KEY"],
+      describe: "Mistral API key",
+    })
+    .option("base-url", {
+      type: "string",
+      default: process.env["MISTRAL_BASE_URL"] ?? "wss://api.mistral.ai",
+      describe: "API base URL",
+    })
+    .help()
+    .parseSync();
+
+  return {
+    model: argv.model,
+    encoding: argv.encoding,
+    sampleRate: argv.sampleRate,
+    apiKey: argv.apiKey,
+    baseUrl: argv.baseUrl,
+  };
+}
+
+async function* captureAudio(
+  sampleRate: number,
+): AsyncGenerator<Uint8Array, void, unknown> {
+  const recorder: ChildProcess = spawn(
+    "rec",
+    [
+      "-q",
+      "-t", "raw",
+      "-b", "16",
+      "-e", "signed-integer",
+      "-r", String(sampleRate),
+      "-c", "1",
+      "-",
+    ],
+    { stdio: ["ignore", "pipe", "ignore"] },
+  );
+
+  recorder.on("error", (err) => {
+    const error = err as NodeJS.ErrnoException;
+    if (error.code === "ENOENT") {
+      console.error(
+        "\nError: 'rec' not found. Install SoX: brew install sox (macOS) or apt install sox (Linux)",
+      );
+      process.exit(1);
+    }
+    throw err;
+  });
+
+  try {
+    if (!recorder.stdout) {
+      throw new Error("Failed to create audio capture stream");
+    }
+    for await (const chunk of recorder.stdout) {
+      yield new Uint8Array(chunk as Buffer);
+    }
+  } finally {
+    if (!recorder.killed) {
+      recorder.kill("SIGTERM");
+    }
+  }
+}
+
+function clearLine(): void {
+  process.stdout.write("\x1b[2K\r");
+}
+
+async function main(): Promise<void> {
+  const args = parseArgs();
+
+  const apiKey = args.apiKey ?? process.env["MISTRAL_API_KEY"];
+  if (!apiKey) {
+    console.error(
+      "Missing MISTRAL_API_KEY. Set the environment variable or pass --api-key.",
+    );
+    process.exit(1);
+  }
+
+  const client = new RealtimeTranscription({
+    apiKey: apiKey,
+    serverURL: args.baseUrl,
+  });
+
+  console.log("Listening... (Ctrl+C to stop)\n");
+
+  const audioStream = captureAudio(args.sampleRate);
+
+  process.on("SIGINT", () => {
+    clearLine();
+    console.log("\nStopped.");
+    process.exit(0);
+  });
+
+  try {
+    for await (const event of client.transcribeStream(
+      audioStream,
+      args.model,
+      {
+        audioFormat: {
+          encoding: args.encoding,
+          sampleRate: args.sampleRate,
+        },
+      },
+    )) {
+      if (event.type === "transcription.text.delta") {
+        process.stdout.write(event.text);
+        continue;
+      }
+      if (event.type === "transcription.done") {
+        process.stdout.write("\n");
+        break;
+      }
+      if (event.type === "error") {
+        const errorMessage = typeof event.error.message === "string"
+          ? event.error.message
+          : JSON.stringify(event.error.message);
+        console.error(`\nTranscription error: ${errorMessage}`);
+        process.exitCode = 1;
+        break;
+      }
+    }
+  } finally {
+    await audioStream.return?.();
+  }
+}
+
+await main();

package/examples/src/realtime_transcription.ts

@@ -0,0 +1,225 @@
+import { spawn } from "node:child_process";
+import { randomUUID } from "node:crypto";
+import { createReadStream, promises as fs } from "node:fs";
+import { tmpdir } from "node:os";
+import { extname, join, resolve } from "node:path";
+import yargs from "yargs/yargs";
+import { hideBin } from "yargs/helpers";
+
+import {
+  AudioEncoding,
+  RealtimeTranscription,
+} from "@mistralai/mistralai/extra/realtime";
+
+type KnownAudioEncoding = (typeof AudioEncoding)[keyof typeof AudioEncoding];
+
+const DEFAULT_ENCODING: KnownAudioEncoding = AudioEncoding.PcmS16le;
+const DEFAULT_SAMPLE_RATE = 16000;
+
+const FFMPEG_FORMAT_BY_ENCODING: Record<KnownAudioEncoding, string> = {
+  [AudioEncoding.PcmS16le]: "s16le",
+  [AudioEncoding.PcmS32le]: "s32le",
+  [AudioEncoding.PcmF32le]: "f32le",
+  [AudioEncoding.PcmF16le]: "f16le",
+  [AudioEncoding.PcmMulaw]: "mulaw",
+  [AudioEncoding.PcmAlaw]: "alaw",
+};
+
+type Args = {
+  file?: string;
+  model: string;
+  apiKey?: string;
+  baseUrl: string;
+  noConvert: boolean;
+};
+
+function parseArgs(): Args {
+  const argv = yargs(hideBin(process.argv))
+    .usage("Usage: $0 <file> [options]")
+    .option("model", {
+      type: "string",
+      default: "voxtral-mini-transcribe-realtime-2602",
+      describe: "Model ID",
+    })
+    .option("api-key", {
+      type: "string",
+      default: process.env["MISTRAL_API_KEY"],
+      describe: "Mistral API key",
+    })
+    .option("base-url", {
+      type: "string",
+      default: process.env["MISTRAL_BASE_URL"] ?? "https://api.mistral.ai",
+      describe: "API base URL",
+    })
+    .option("no-convert", {
+      type: "boolean",
+      default: false,
+      describe: "Skip ffmpeg conversion (input must be raw PCM)",
+    })
+    .help()
+    .parseSync();
+
+  const fileArg = argv._[0];
+  const file = typeof fileArg === "string" ? fileArg : undefined;
+
+  return {
+    file,
+    model: argv.model,
+    apiKey: argv.apiKey,
+    baseUrl: argv.baseUrl,
+    noConvert: argv.noConvert,
+  };
+}
+
+async function runFfmpeg(args: string[]): Promise<void> {
+  await new Promise<void>((resolve, reject) => {
+    const child = spawn("ffmpeg", args, {
+      stdio: ["ignore", "ignore", "pipe"],
+    });
+
+    let stderr = "";
+    child.stderr.setEncoding("utf8");
+    child.stderr.on("data", (chunk) => {
+      stderr += chunk;
+    });
+
+    child.on("error", (err) => {
+      const error = err as NodeJS.ErrnoException;
+      if (error.code === "ENOENT") {
+        reject(new Error(
+          "ffmpeg not found. Install ffmpeg or use --no-convert with raw PCM input.",
+        ));
+        return;
+      }
+      reject(err);
+    });
+
+    child.on("close", (code) => {
+      if (code === 0) {
+        resolve();
+        return;
+      }
+      const details = stderr.trim();
+      reject(new Error(
+        `ffmpeg conversion failed${details ? `: ${details}` : ""}`,
+      ));
+    });
+  });
+}
+
+async function convertAudioToPcm(
+  inputPath: string,
+  encoding: KnownAudioEncoding,
+  sampleRate: number,
+): Promise<string> {
+  const tempPath = join(
+    tmpdir(),
+    `mistral-realtime-${randomUUID()}.pcm`,
+  );
+
+  const ffmpegFormat = FFMPEG_FORMAT_BY_ENCODING[encoding];
+  const args = [
+    "-y",
+    "-i",
+    inputPath,
+    "-f",
+    ffmpegFormat,
+    "-ar",
+    String(sampleRate),
+    "-ac",
+    "1",
+    tempPath,
+  ];
+
+  try {
+    await runFfmpeg(args);
+  } catch (err) {
+    await fs.unlink(tempPath).catch(() => undefined);
+    throw err;
+  }
+
+  return tempPath;
+}
+
+async function* streamAudioFile(
+  filePath: string,
+  chunkSize: number = 4096,
+): AsyncIterable<Uint8Array> {
+  for await (const chunk of createReadStream(filePath, { highWaterMark: chunkSize })) {
+    yield chunk as Uint8Array;
+  }
+}
+
+async function main(): Promise<void> {
+  const args = parseArgs();
+  if (!args.file) {
+    console.error(
+      "Missing audio file. Provide a file path after the script name.",
+    );
+    return;
+  }
+
+  const apiKey = args.apiKey ?? process.env["MISTRAL_API_KEY"];
+  if (!apiKey) {
+    throw new Error(
+      "Missing MISTRAL_API_KEY. Set the environment variable or pass --api-key.",
+    );
+  }
+
+  const inputPath = resolve(args.file);
+
+  let audioPath = inputPath;
+  let tempPath: string | undefined;
+
+  const extension = extname(inputPath).toLowerCase();
+  const isRawPcm = extension === ".pcm" || extension === ".raw";
+  if (!args.noConvert && !isRawPcm) {
+    tempPath = await convertAudioToPcm(
+      inputPath,
+      DEFAULT_ENCODING,
+      DEFAULT_SAMPLE_RATE,
+    );
+    audioPath = tempPath;
+  }
+
+  const client = new RealtimeTranscription({
+    apiKey: apiKey,
+    serverURL: args.baseUrl,
+  });
+
+  try {
+    for await (const event of client.transcribeStream(
+      streamAudioFile(audioPath),
+      args.model,
+      {
+        audioFormat: {
+          encoding: DEFAULT_ENCODING,
+          sampleRate: DEFAULT_SAMPLE_RATE,
+        },
+      },
+    )) {
+      if (event.type === "transcription.text.delta") {
+        process.stdout.write(event.text);
+        continue;
+      }
+      if (event.type === "transcription.done") {
+        process.stdout.write("\n");
+        break;
+      }
+      if (event.type === "error") {
+        const errorMessage = typeof event.error.message === "string"
+          ? event.error.message
+          : JSON.stringify(event.error.message);
+        console.error(`Transcription error: ${errorMessage}`);
+        process.exitCode = 1;
+        break;
+      }
+    }
+  } finally {
+    if (tempPath) {
+      await fs.unlink(tempPath).catch(() => undefined);
+    }
+  }
+}
+
+await main();

package/extra/realtime/connection.d.ts

@@ -0,0 +1,44 @@
+import WebSocket from "ws";
+import { TranscriptionStreamDone } from "../../models/components/transcriptionstreamdone.js";
+import { TranscriptionStreamLanguage } from "../../models/components/transcriptionstreamlanguage.js";
+import { TranscriptionStreamSegmentDelta } from "../../models/components/transcriptionstreamsegmentdelta.js";
+import { TranscriptionStreamTextDelta } from "../../models/components/transcriptionstreamtextdelta.js";
+import { type AudioFormat } from "../../models/components/audioformat.js";
+import { type RealtimeTranscriptionError } from "../../models/components/realtimetranscriptionerror.js";
+import type { RealtimeTranscriptionSession } from "../../models/components/realtimetranscriptionsession.js";
+import { type RealtimeTranscriptionSessionCreated } from "../../models/components/realtimetranscriptionsessioncreated.js";
+import { type RealtimeTranscriptionSessionUpdated } from "../../models/components/realtimetranscriptionsessionupdated.js";
+export type KnownRealtimeEvent = RealtimeTranscriptionSessionCreated | RealtimeTranscriptionSessionUpdated | RealtimeTranscriptionError | TranscriptionStreamLanguage | TranscriptionStreamSegmentDelta | TranscriptionStreamTextDelta | TranscriptionStreamDone;
+export type UnknownRealtimeEvent = {
+    type: string;
+    raw: unknown;
+    error?: Error | undefined;
+};
+export type RealtimeEvent = KnownRealtimeEvent | UnknownRealtimeEvent;
+/** @internal */
+export declare function isUnknownRealtimeEvent(event: RealtimeEvent): event is UnknownRealtimeEvent;
+/** @internal */
+export declare function parseRealtimeEventFromData(data: unknown): RealtimeEvent;
+/** WebSocket connection for realtime transcription. */
+export declare class RealtimeConnection implements AsyncIterable<RealtimeEvent> {
+    private readonly websocket;
+    private closed;
+    private currentAudioFormat;
+    private currentSession;
+    private initialEvents;
+    constructor(websocket: WebSocket, session: RealtimeTranscriptionSession, initialEvents?: RealtimeEvent[]);
+    get requestId(): string;
+    get session(): RealtimeTranscriptionSession;
+    get audioFormat(): AudioFormat;
+    get isClosed(): boolean;
+    [Symbol.asyncIterator](): AsyncIterator<RealtimeEvent>;
+    events(): AsyncGenerator<RealtimeEvent>;
+    sendAudio(audioBytes: Uint8Array | ArrayBuffer): Promise<void>;
+    flushAudio(): Promise<void>;
+    updateSession(audioFormat: AudioFormat): Promise<void>;
+    endAudio(): Promise<void>;
+    close(code?: number, reason?: string): Promise<void>;
+    private sendJson;
+    private applySessionEvent;
+}
+//# sourceMappingURL=connection.d.ts.map

package/extra/realtime/connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/extra/realtime/connection.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,IAAI,CAAC;AAC3B,OAAO,EACL,uBAAuB,EAExB,MAAM,oDAAoD,CAAC;AAC5D,OAAO,EACL,2BAA2B,EAE5B,MAAM,wDAAwD,CAAC;AAChE,OAAO,EACL,+BAA+B,EAEhC,MAAM,4DAA4D,CAAC;AACpE,OAAO,EACL,4BAA4B,EAE7B,MAAM,yDAAyD,CAAC;AACjE,OAAO,EAEL,KAAK,WAAW,EACjB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAEL,KAAK,0BAA0B,EAChC,MAAM,uDAAuD,CAAC;AAC/D,OAAO,KAAK,EACV,4BAA4B,EAC7B,MAAM,yDAAyD,CAAC;AACjE,OAAO,EAEL,KAAK,mCAAmC,EACzC,MAAM,gEAAgE,CAAC;AACxE,OAAO,EAEL,KAAK,mCAAmC,EACzC,MAAM,gEAAgE,CAAC;AAKxE,MAAM,MAAM,kBAAkB,GAC1B,mCAAmC,GACnC,mCAAmC,GACnC,0BAA0B,GAC1B,2BAA2B,GAC3B,+BAA+B,GAC/B,4BAA4B,GAC5B,uBAAuB,CAAC;AAE5B,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,kBAAkB,GAAG,oBAAoB,CAAC;AAEtE,gBAAgB;AAChB,wBAAgB,sBAAsB,CACpC,KAAK,EAAE,aAAa,GACnB,KAAK,IAAI,oBAAoB,CAE/B;AAED,gBAAgB;AAChB,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,OAAO,GAAG,aAAa,CAkBvE;AAED,uDAAuD;AACvD,qBAAa,kBAAmB,YAAW,aAAa,CAAC,aAAa,CAAC;IACrE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,kBAAkB,CAAc;IACxC,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,aAAa,CAAkB;gBAGrC,SAAS,EAAE,SAAS,EACpB,OAAO,EAAE,4BAA4B,EACrC,aAAa,GAAE,aAAa,EAAO;IAQrC,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,OAAO,IAAI,4BAA4B,CAE1C;IAED,IAAI,WAAW,IAAI,WAAW,CAE7B;IAED,IAAI,QAAQ,IAAI,OAAO,CAMtB;IAED,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,aAAa,CAAC;IAI/C,MAAM,IAAI,cAAc,CAAC,aAAa,CAAC;IAkFxC,SAAS,CAAC,UAAU,EAAE,UAAU,GAAG,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9D,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ3B,aAAa,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAgBtD,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAQzB,KAAK,CAAC,IAAI,GAAE,MAAa,EAAE,MAAM,GAAE,MAAW,GAAG,OAAO,CAAC,IAAI,CAAC;YAqBtD,QAAQ;IAatB,OAAO,CAAC,iBAAiB;CAU1B"}