Tree BG 1
Tree
Tree
TreeLeaves
TreeLeaves
Cat IdleGrassGrassRockRock

Batch

API Batch

Obtenir les tâches par lots

GET /v1/batch/jobs

Obtenir une liste des tâches par lots pour votre organisation et utilisateur.

200

OK

object
string

Default Value: "list"

total
*integer

Playground

Testez les endpoints en direct

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

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

async function run() {
  const result = await mistral.batch.jobs.list({});

  console.log(result);
}

run();
from mistralai.client import Mistral
import os


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

    res = mistral.batch.jobs.list(page=0, page_size=100, created_by_me=False, order_by="-created")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/batch/jobs \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "total": 87
}

Créer une tâche par lots

POST /v1/batch/jobs

Créer une nouvelle tâche par lots, elle sera mise en file d'attente pour traitement.

200

OK

agent_id
string|null
completed_at
integer|null
completed_requests
*integer
created_at
*integer
endpoint
*string
error_file
string|null
failed_requests
*integer
id
*string
input_files
*array<string>
metadata
map<any>|null
model
string|null
object
string

Default Value: "batch"

output_file
string|null
outputs
array<map<any>>|null
started_at
integer|null
status
*"QUEUED"|"RUNNING"|"SUCCESS"|"FAILED"|"TIMEOUT_EXCEEDED"|"CANCELLATION_REQUESTED"|"CANCELLED"
succeeded_requests
*integer
total_requests
*integer

Playground

Testez les endpoints en direct

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

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

async function run() {
  const result = await mistral.batch.jobs.create({
    inputFiles: [
      "fe3343a2-3b8d-404b-ba32-a78dede2614a",
    ],
    endpoint: "/v1/classifications",
  });

  console.log(result);
}

run();
from mistralai.client import Mistral
import os


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

    res = mistral.batch.jobs.create(endpoint="/v1/moderations", model="mistral-small-latest", timeout_hours=24)

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/batch/jobs \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json' \
 -d '{
  "endpoint": "/v1/chat/completions"
}'

200

{
  "completed_requests": "10",
  "created_at": 14,
  "endpoint": "/v1/chat/completions",
  "errors": [
    {
      "message": "Example message."
    }
  ],
  "failed_requests": "0",
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "input_files": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ],
  "status": "QUEUED",
  "succeeded_requests": "10",
  "total_requests": "10"
}

Obtenir un traitement par lots

GET /v1/batch/jobs/{job_id}

Obtenir les détails d'un traitement par lots par son UUID.

Args: inline : Si True, retourne les résultats en ligne dans la réponse.

200

OK

agent_id
string|null
completed_at
integer|null
completed_requests
*integer
created_at
*integer
endpoint
*string
error_file
string|null
failed_requests
*integer
id
*string
input_files
*array<string>
metadata
map<any>|null
model
string|null
object
string

Default Value: "batch"

output_file
string|null
outputs
array<map<any>>|null
started_at
integer|null
status
*"QUEUED"|"RUNNING"|"SUCCESS"|"FAILED"|"TIMEOUT_EXCEEDED"|"CANCELLATION_REQUESTED"|"CANCELLED"
succeeded_requests
*integer
total_requests
*integer

Playground

Testez les endpoints en direct

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

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

async function run() {
  const result = await mistral.batch.jobs.get({
    jobId: "4017dc9f-b629-42f4-9700-8c681b9e7f0f",
  });

  console.log(result);
}

run();
from mistralai.client import Mistral
import os


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

    res = mistral.batch.jobs.get(job_id="4017dc9f-b629-42f4-9700-8c681b9e7f0f")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/batch/jobs/{job_id} \
 -X GET \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE'

200

{
  "completed_requests": "10",
  "created_at": 14,
  "endpoint": "/v1/chat/completions",
  "errors": [
    {
      "message": "Example message."
    }
  ],
  "failed_requests": "0",
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "input_files": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ],
  "status": "QUEUED",
  "succeeded_requests": "10",
  "total_requests": "10"
}

Supprimer un traitement par lots

DELETE /v1/batch/jobs/{job_id}

Demander la suppression d'une tâche par lots.

200

OK

deleted
boolean

Default Value: true

id
*string
object
string

Default Value: "batch"

Playground

Testez les endpoints en direct

curl https://api.mistral.ai/v1/batch/jobs/{job_id} \
 -X DELETE \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

{
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088"
}

Annuler un traitement par lots

POST /v1/batch/jobs/{job_id}/cancel

Demander l'annulation d'un traitement par lots.

200

OK

agent_id
string|null
completed_at
integer|null
completed_requests
*integer
created_at
*integer
endpoint
*string
error_file
string|null
failed_requests
*integer
id
*string
input_files
*array<string>
metadata
map<any>|null
model
string|null
object
string

Default Value: "batch"

output_file
string|null
outputs
array<map<any>>|null
started_at
integer|null
status
*"QUEUED"|"RUNNING"|"SUCCESS"|"FAILED"|"TIMEOUT_EXCEEDED"|"CANCELLATION_REQUESTED"|"CANCELLED"
succeeded_requests
*integer
total_requests
*integer

Playground

Testez les endpoints en direct

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

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

async function run() {
  const result = await mistral.batch.jobs.cancel({
    jobId: "4fb29d1c-535b-4f0a-a1cb-2167f86da569",
  });

  console.log(result);
}

run();
from mistralai.client import Mistral
import os


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

    res = mistral.batch.jobs.cancel(job_id="4fb29d1c-535b-4f0a-a1cb-2167f86da569")

    # Handle response
    print(res)

curl https://api.mistral.ai/v1/batch/jobs/{job_id}/cancel \
 -X POST \
 -H 'Authorization: Bearer YOUR_APIKEY_HERE' \
 -H 'Content-Type: application/json'

200

{
  "completed_requests": "10",
  "created_at": 14,
  "endpoint": "/v1/chat/completions",
  "errors": [
    {
      "message": "Example message."
    }
  ],
  "failed_requests": "0",
  "id": "019b2bd7-96e7-7219-8c0b-45a73da50088",
  "input_files": [
    "019b2bd7-96e7-7219-8c0b-45a73da50088"
  ],
  "status": "QUEUED",
  "succeeded_requests": "10",
  "total_requests": "10"
}