Class MistralAiBatchChatModel

java.lang.Object

dev.langchain4j.model.mistralai.MistralAiBatchChatModel

All Implemented Interfaces:

BatchChatModel

@Experimental
public final class MistralAiBatchChatModel
extends Object
implements BatchChatModel

A BatchChatModel for the Mistral Batch API, which processes multiple chat requests asynchronously at 50% of the standard per-token price.

Requests are submitted inline: each ChatRequest is mapped to a request identical to the one MistralAiChatModel would send, so per-request parameters (temperature, tools, response format, etc.) behave the same in a batch as in a single call. The returned BatchResponse carries the batch id and its current BatchState; results are fetched by retrieve(String) once the job has produced them, preserving submission order.

All requests in a batch run against the single model configured on this batch model (via MistralAiBatchChatModel.Builder.modelName(String)), matching the Mistral constraint of one model per job.

See Also:

• BatchChatModel
• BatchResponse

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MistralAiBatchChatModel.Builder

Constructor Summary

Constructors

Constructor	Description
MistralAiBatchChatModel(MistralAiBatchChatModel.Builder builder)

Method Summary

Modifier and Type	Method	Description
static MistralAiBatchChatModel.Builder	builder()
void	cancel(String batchId)	Cancels a chat batch operation that is currently pending or running.
BatchPage<ChatResponse>	list(@Nullable BatchPagination pagination)	Lists chat batch jobs with optional pagination.
BatchResponse<ChatResponse>	retrieve(String batchId)	Retrieves the current state and results of a chat batch operation.
BatchResponse<ChatResponse>	submit(BatchRequest<ChatRequest> request)	Creates a batch of chat requests and submits them for asynchronous processing.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MistralAiBatchChatModel

public MistralAiBatchChatModel(MistralAiBatchChatModel.Builder builder)

Method Details

submit

public BatchResponse<ChatResponse> submit(BatchRequest<ChatRequest> request)

Description copied from interface: BatchChatModel

Creates a batch of chat requests and submits them for asynchronous processing.

The returned BatchResponse represents the status of the batch operation.

Specified by:

submit in interface BatchChatModel

Parameters:

request - the list of chat requests to process in the batch

Returns:

a BatchResponse representing the initial state of the batch operation

retrieve

public BatchResponse<ChatResponse> retrieve(String batchId)

Description copied from interface: BatchChatModel

Retrieves the current state and results of a chat batch operation.

The response indicates whether the batch is still processing, completed successfully, or failed. Clients should poll this method at intervals until the batch completes.

Specified by:

retrieve in interface BatchChatModel

Parameters:

batchId - the batch identifier obtained from BatchChatModel.submit(BatchRequest)

Returns:

a BatchResponse representing the current state of the chat batch operation

cancel

public void cancel(String batchId)

Description copied from interface: BatchChatModel

Cancels a chat batch operation that is currently pending or running.

Specified by:

cancel in interface BatchChatModel

Parameters:

batchId - the batch identifier to cancel

list

public BatchPage<ChatResponse> list(@Nullable BatchPagination pagination)

Lists chat batch jobs with optional pagination.

The Mistral Batch API paginates by zero-based page index. When more pages remain, the returned BatchPage.nextPageToken() is the next page index (as a string) to pass back via BatchPagination.pageToken().

Specified by:

list in interface BatchChatModel

Parameters:

pagination - the maximum number of batch jobs to return and token for retrieving a specific page; if null, uses server default

Returns:

a BatchPage containing chat batch responses and pagination information

builder

public static MistralAiBatchChatModel.Builder builder()