Download OpenAPI Spec
Home
Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Classifiers Endpoints

Classifiers API.

Moderations

POST /v1/moderations

200

Successful Response

id
*string
model
*string
results
*array<ModerationObject>

Playground

Test the endpoints live

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

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

async function run() {
  const result = await mistral.classifiers.moderate({
    model: "Durango",
    inputs: [
      "<value 1>",
      "<value 2>",
    ],
  });

  console.log(result);
}

run();

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.classifiers.moderate(
    model="mistral-moderation-latest",
    inputs="I want to buy a new laptop.",
)

print(response.results)

curl https://api.mistral.ai/v1/moderations \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "input": "Example input.",
  "model": "mistral-moderation-latest"
}'

200

{
  "id": "4d71ae510af942108ef7344f903e2b88",
  "model": "mistral-moderation-latest",
  "results": [
    {
      "categories": {
        "sexual": false,
        "hate_and_discrimination": false,
        "violence_and_threats": false,
        "dangerous_and_criminal_content": false,
        "selfharm": false,
        "health": false,
        "financial": false,
        "law": false,
        "pii": false
      },
      "category_scores": {
        "sexual": 0.0011335690505802631,
        "hate_and_discrimination": 0.0030753696337342262,
        "violence_and_threats": 0.0003569706459529698,
        "dangerous_and_criminal_content": 0.002251847181469202,
        "selfharm": 0.00017952796770259738,
        "health": 0.0002780309587251395,
        "financial": 0.00008481103577651083,
        "law": 0.00004539786823443137,
        "pii": 0.0023967307060956955
      }
    },
    {
      "categories": {
        "sexual": false,
        "hate_and_discrimination": false,
        "violence_and_threats": false,
        "dangerous_and_criminal_content": false,
        "selfharm": false,
        "health": false,
        "financial": false,
        "law": false,
        "pii": false
      },
      "category_scores": {
        "sexual": 0.000626334105618298,
        "hate_and_discrimination": 0.0013670255430042744,
        "violence_and_threats": 0.0002611903182696551,
        "dangerous_and_criminal_content": 0.0030753696337342262,
        "selfharm": 0.00010889690747717395,
        "health": 0.00015843621804378927,
        "financial": 0.000191104321856983,
        "law": 0.00004006369272246957,
        "pii": 0.0035936026833951473
      }
    }
  ]
}

Chat Moderations

POST /v1/chat/moderations

200

Successful Response

id
*string
model
*string
results
*array<ModerationObject>

Playground

Test the endpoints live

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

const client = new Mistral({ apiKey: process.env.MISTRAL_API_KEY });

const response = await client.classifiers.moderateChat({
  model: "mistral-moderation-latest",
  inputs: [
    {
      role: "user",
      content: "I want to buy a new laptop.",
    },
  ],
});

console.log(response.results);

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.classifiers.moderate_chat(
    model="mistral-moderation-latest",
    inputs=[{"role": "user", "content": "I want to buy a new laptop."}],
)

print(response.results)

curl https://api.mistral.ai/v1/chat/moderations \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "input": [
    {
      "content": "Example content."
    }
  ],
  "model": "mistral-small-latest"
}'

200

{
  "id": "352bce1a55814127a3b0bc4fb8f02a35",
  "model": "mistral-moderation-latest",
  "results": [
    {
      "categories": {
        "sexual": false,
        "hate_and_discrimination": false,
        "violence_and_threats": false,
        "dangerous_and_criminal_content": false,
        "selfharm": false,
        "health": false,
        "financial": false,
        "law": false,
        "pii": false
      },
      "category_scores": {
        "sexual": 0.0010322310263291001,
        "hate_and_discrimination": 0.001597845577634871,
        "violence_and_threats": 0.00020342698553577065,
        "dangerous_and_criminal_content": 0.0029810327105224133,
        "selfharm": 0.00017952796770259738,
        "health": 0.0002959570847451687,
        "financial": 0.000079673009167891,
        "law": 0.00004539786823443137,
        "pii": 0.004198795650154352
      }
    }
  ]
}

Classifications

POST /v1/classifications

200

Successful Response

id
*string
model
*string
results
*array<map<ClassificationTargetResult>>

Playground

Test the endpoints live

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

const mistral = new Mistral({
  apiKey: "MISTRAL_API_KEY",
});

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

  console.log(result);
}

run();

from mistralai.client import Mistral
import os


with Mistral(
    api_key=os.getenv("MISTRAL_API_KEY", ""),
) as mistral:

    res = mistral.classifiers.classify(model="mistral-moderation-latest", inputs=[
        "<value 1>",
    ])

    # Handle response
    print(res)


curl https://api.mistral.ai/v1/classifications \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "input": "Example input.",
  "model": "mistral-moderation-latest"
}'

200

{
  "id": "mod-e5cc70bb28c444948073e77776eb30ef",
  "model": "mistral-small-latest",
  "results": [
    [
      {
        "scores": [
          87
        ]
      }
    ]
  ]
}

Chat Classifications

POST /v1/chat/classifications

200

Successful Response

id
*string
model
*string
results
*array<map<ClassificationTargetResult>>

Playground

Test the endpoints live

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

const client = new Mistral({ apiKey: process.env.MISTRAL_API_KEY });

const response = await client.classifiers.classifyChat({
  model: "mistral-classifier-latest",
  input: [
    {
      messages: [
        { role: "user", content: "I loved the product." },
      ],
    },
  ],
});

console.log(response.results);

import os
from mistralai import Mistral

client = Mistral(api_key=os.environ["MISTRAL_API_KEY"])

response = client.classifiers.classify_chat(
    model="mistral-classifier-latest",
    input=[{"messages": [{"role": "user", "content": "I loved the product."}]}],
)

print(response.results)

curl https://api.mistral.ai/v1/chat/classifications \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "input": {
    "messages": [
      {
        "content": "Example content."
      }
    ]
  },
  "model": "mistral-small-latest"
}'

200

{
  "id": "mod-e5cc70bb28c444948073e77776eb30ef",
  "model": "mistral-small-latest",
  "results": [
    [
      {
        "scores": [
          87
        ]
      }
    ]
  ]
}