Create a Mistral inference endpoint
- PUT /_inference/{task_type}/{mistral_inference_id}
Create an inference endpoint to perform an inference task with the mistral service.
- Cluster privileges:
manage_inference
Path Parameters
-
task_typeMistralTaskTyperequired -
The type of the inference task that the model will perform.
-
Values:
text_embeddingcompletionchat_completion -
mistral_inference_idstring Idrequired -
The unique identifier of the inference endpoint.
Query Parameters
-
timeoutstring Duration · default: 30s Specifies the amount of time to wait for the inference endpoint to be created.
Request
-
chunking_settingsInferenceChunkingSettings -
The chunking configuration object.
- Reference
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
strategystring · default: sentence -
The chunking strategy:
sentenceorword. -
serviceMistralServiceTyperequired -
The type of service supported for the specified task type. In this case,
mistral. -
Values:
mistral -
service_settingsMistralServiceSettingsrequired -
Settings used to install the inference model. These settings are specific to the
mistralservice. -
api_keystringrequired -
A valid API key of your Mistral account. You can find your Mistral API keys or you can create a new one on the API Keys page.
IMPORTANT: You need to provide the API key only once, during the inference model creation. The get inference endpoint API does not retrieve your API key.
- External docs
-
max_input_tokensnumber -
The maximum number of tokens per input before chunking occurs.
-
modelstringrequired -
The name of the model to use for the inference task. Refer to the Mistral models documentation for the list of available models.
- External docs
-
rate_limitRateLimitSetting -
This setting helps to minimize the number of rate limit errors returned from the Mistral API. By default, the
mistralservice sets the number of requests allowed per minute to 240. -
requests_per_minutenumber -
The number of requests allowed per minute.
Response
-
chunking_settingsInferenceChunkingSettings -
Chunking configuration object
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be higher than
300or lower than20(forsentencestrategy) or10(forwordstrategy). -
overlapnumber · default: 100 -
The number of overlapping words for chunks. It is applicable only to a
wordchunking strategy. This value cannot be higher than half themax_chunk_sizevalue. -
sentence_overlapnumber · default: 1 -
The number of overlapping sentences for chunks. It is applicable only for a
sentencechunking strategy. It can be either1or0. -
strategystring · default: sentence -
The chunking strategy:
sentenceorword. -
servicestringrequired -
The service type
-
service_settingsServiceSettingsrequired -
Settings specific to the service
-
task_settingsTaskSettings -
Task settings specific to the service and task type
-
inference_idstringrequired -
The inference Id