Skip to content

README.md

Latest commit

 

History

History
352 lines (268 loc) · 24.3 KB

README.md

File metadata and controls

352 lines (268 loc) · 24.3 KB

Classifiers

Overview

Classifiers API.

Available Operations

moderate

Moderations

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.classifiers.moderate({
    model: "mistral-moderation-latest",
    inputs: "<value>",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { classifiersModerate } from "@mistralai/mistralai/funcs/classifiersModerate.js";

// Use `MistralCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const mistral = new MistralCore({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const res = await classifiersModerate(mistral, {
    model: "mistral-moderation-latest",
    inputs: "<value>",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("classifiersModerate failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request components.ClassificationRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ModerationResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

moderateChat

Chat Moderations

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.classifiers.moderateChat({
    inputs: [
      {
        role: "tool",
        content: "<value>",
      },
    ],
    model: "LeBaron",
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { classifiersModerateChat } from "@mistralai/mistralai/funcs/classifiersModerateChat.js";

// Use `MistralCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const mistral = new MistralCore({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const res = await classifiersModerateChat(mistral, {
    inputs: [
      {
        role: "tool",
        content: "<value>",
      },
    ],
    model: "LeBaron",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("classifiersModerateChat failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request components.ChatModerationRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ModerationResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

classify

Classifications

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.classifiers.classify({
    model: "mistral-moderation-latest",
    inputs: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { classifiersClassify } from "@mistralai/mistralai/funcs/classifiersClassify.js";

// Use `MistralCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const mistral = new MistralCore({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const res = await classifiersClassify(mistral, {
    model: "mistral-moderation-latest",
    inputs: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("classifiersClassify failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request components.ClassificationRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ClassificationResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*

classifyChat

Chat Classifications

Example Usage

import { Mistral } from "@mistralai/mistralai";

const mistral = new Mistral({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const result = await mistral.classifiers.classifyChat({
    model: "Camry",
    input: [
      {
        messages: [
          {
            role: "system",
            content: "<value>",
          },
        ],
      },
    ],
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { MistralCore } from "@mistralai/mistralai/core.js";
import { classifiersClassifyChat } from "@mistralai/mistralai/funcs/classifiersClassifyChat.js";

// Use `MistralCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const mistral = new MistralCore({
  apiKey: process.env["MISTRAL_API_KEY"] ?? "",
});

async function run() {
  const res = await classifiersClassifyChat(mistral, {
    model: "Camry",
    input: [
      {
        messages: [
          {
            role: "system",
            content: "<value>",
          },
        ],
      },
    ],
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("classifiersClassifyChat failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request components.ChatClassificationRequest ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.ClassificationResponse>

Errors

Error Type Status Code Content Type
errors.HTTPValidationError 422 application/json
errors.SDKError 4XX, 5XX */*