README.md

Classifiers

(classifiers)

Overview

Classifiers API.

Available Operations

• moderate - Moderations
• moderate_chat - Chat Moderations
• classify - Classifications
• classify_chat - Chat Classifications

moderate

Moderations

Example Usage

from mistralai import Mistral
import os


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

    res = mistral.classifiers.moderate(model="V90", inputs=[
        "<value>",
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
model	str	✔️	ID of the model to use.
inputs	models.ClassificationRequestInputs	✔️	Text to classify.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ModerationResponse

Errors

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

moderate_chat

Chat Moderations

Example Usage

from mistralai import Mistral
import os


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

    res = mistral.classifiers.moderate_chat(inputs=[
        [
            {
                "content": [

                ],
                "role": "system",
            },
            {
                "content": "<value>",
                "role": "tool",
            },
        ],
        [
            {
                "prefix": False,
                "role": "assistant",
            },
            {
                "content": "<value>",
                "role": "user",
            },
            {
                "prefix": False,
                "role": "assistant",
            },
        ],
        [
            {
                "content": "<value>",
                "role": "system",
            },
            {
                "content": [
                    {
                        "image_url": "https://fatherly-colon.name",
                        "type": "image_url",
                    },
                ],
                "role": "user",
            },
            {
                "content": "<value>",
                "role": "user",
            },
        ],
    ], model="Model Y")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
inputs	models.ChatModerationRequestInputs	✔️	Chat to classify
model	str	✔️	N/A
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ModerationResponse

Errors

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

classify

Classifications

Example Usage

from mistralai import Mistral
import os


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

    res = mistral.classifiers.classify(model="Altima", inputs="<value>")

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
model	str	✔️	ID of the model to use.
inputs	models.ClassificationRequestInputs	✔️	Text to classify.
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ClassificationResponse

Errors

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

classify_chat

Chat Classifications

Example Usage

from mistralai import Mistral
import os


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

    res = mistral.classifiers.classify_chat(model="Fortwo", inputs=[
        {
            "messages": [
                {
                    "content": "<value>",
                    "role": "tool",
                },
            ],
        },
        {
            "messages": [

            ],
        },
    ])

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
model	str	✔️	N/A
inputs	models.Inputs	✔️	Chat to classify
retries	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ClassificationResponse

Errors

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