Create a VoyageAI inference endpoint
- PUT /_inference/{task_type}/{voyageai_inference_id}
Create an inference endpoint to perform an inference task with the voyageai service.
Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.
- Cluster privileges:
manage_inference
Path Parameters
-
task_typeVoyageAITaskTyperequired -
The type of the inference task that the model will perform.
-
Values:
text_embeddingrerank -
voyageai_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. Applies only to the
text_embeddingtask type. Not applicable to thereranktask type. - Reference
-
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be lower than
20(forsentencestrategy) or10(forwordstrategy). This value should not exceed the window size for the associated model. -
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. -
separator_groupstring -
Only applicable to the
recursivestrategy and required when using it.Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be
markdownorplaintext.Using this parameter is an alternative to manually specifying a custom
separatorslist. -
separatorsstring -
Only applicable to the
recursivestrategy and required when using it.A list of strings used as possible split points when chunking text.
Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list.
After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the
max_chunk_sizelimit, to reduce the total number of chunks generated. -
serviceVoyageAIServiceTyperequired -
The type of service supported for the specified task type. In this case,
voyageai. -
Values:
voyageai -
service_settingsVoyageAIServiceSettingsrequired -
Settings used to install the inference model. These settings are specific to the
voyageaiservice. -
dimensionsnumber -
The number of dimensions for resulting output embeddings. This setting maps to
output_dimensionin the VoyageAI documentation. Only for thetext_embeddingtask type. - External docs
-
model_idstringrequired -
The name of the model to use for the inference task. Refer to the VoyageAI documentation for the list of available text embedding and rerank models.
- External docs
-
rate_limitRateLimitSetting -
This setting helps to minimize the number of rate limit errors returned from VoyageAI. The
voyageaiservice sets a default number of requests allowed per minute depending on the task type. For bothtext_embeddingandrerank, it is set to2000. -
requests_per_minutenumber -
The number of requests allowed per minute. By default, the number of requests allowed per minute is set by each service as follows:
alibabacloud-ai-searchservice:1000amazonbedrockservice:240anthropicservice:50azureaistudioservice:240azureopenaiservice and task typetext_embedding:1440azureopenaiservice and task typescompletionorchat_completion:120cohereservice:10000contextualaiservice:1000elasticservice and task typechat_completion:240fireworksaiservice:6000googleaistudioservice:360googlevertexaiservice:30000hugging_faceservice:3000jinaaiservice:2000llamaservice:3000mistralservice:240openaiservice and task typetext_embedding:3000openaiservice and task typecompletion:500openshift_aiservice:3000voyageaiservice:2000watsonxaiservice:120
-
embedding_typenumber -
The data type for the embeddings to be returned. This setting maps to
output_dtypein the VoyageAI documentation. Permitted values: float, int8, bit.int8is a synonym ofbytein the VoyageAI documentation.bitis a synonym ofbinaryin the VoyageAI documentation. Only for thetext_embeddingtask type. - External docs
-
task_settingsVoyageAITaskSettings -
Settings to configure the inference task. These settings are specific to the task type you specified.
-
input_typestring -
Type of the input text. Permitted values:
ingest(maps todocumentin the VoyageAI documentation),search(maps toqueryin the VoyageAI documentation). Only for thetext_embeddingtask type. -
return_documentsboolean · default: false -
Whether to return the source documents in the response. Only for the
reranktask type. -
top_knumber -
The number of most relevant documents to return. If not specified, the reranking results of all documents will be returned. Only for the
reranktask type. -
truncationboolean · default: true -
Whether to truncate the input texts to fit within the context length.
Response
-
chunking_settingsInferenceChunkingSettings -
The chunking configuration object. Applies only to the
embedding,sparse_embeddingandtext_embeddingtask types. Not applicable to thererank,completion, orchat_completiontask types. -
max_chunk_sizenumber · default: 250 -
The maximum size of a chunk in words. This value cannot be lower than
20(forsentencestrategy) or10(forwordstrategy). This value should not exceed the window size for the associated model. -
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. -
separator_groupstring -
Only applicable to the
recursivestrategy and required when using it.Sets a predefined list of separators in the saved chunking settings based on the selected text type. Values can be
markdownorplaintext.Using this parameter is an alternative to manually specifying a custom
separatorslist. -
separatorsstring -
Only applicable to the
recursivestrategy and required when using it.A list of strings used as possible split points when chunking text.
Each string can be a plain string or a regular expression (regex) pattern. The system tries each separator in order to split the text, starting from the first item in the list.
After splitting, it attempts to recombine smaller pieces into larger chunks that stay within the
max_chunk_sizelimit, to reduce the total number of chunks generated. -
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