AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 8.19This functionality is generally available and ready for production usage.Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.
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.
The maximum size of a chunk in words.
This value cannot be higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).
overlapnumber · default: 100
The number of overlapping words for chunks.
It is applicable only to a word chunking strategy.
This value cannot be higher than half the max_chunk_size value.
sentence_overlapnumber · default: 1
The number of overlapping sentences for chunks.
It is applicable only for a sentence chunking strategy.
It can be either 1 or 0.
strategystring · default: sentence
The chunking strategy: sentence or word.
serviceenumrequired
The type of service supported for the specified task type. In this case, voyageai.
Values:voyageai
service_settingsobjectrequired
Settings used to install the inference model. These settings are specific to the voyageai service.
dimensionsnumber
The number of dimensions for resulting output embeddings.
This setting maps to output_dimension in the VoyageAI documentation.
Only for the text_embedding task type.
This setting helps to minimize the number of rate limit errors returned from VoyageAI.
The voyageai service sets a default number of requests allowed per minute depending on the task type.
For both text_embedding and rerank, it is set to 2000.
requests_per_minutenumber
The number of requests allowed per minute.
embedding_typenumber
The data type for the embeddings to be returned.
This setting maps to output_dtype in the VoyageAI documentation.
Permitted values: float, int8, bit.
int8 is a synonym of byte in the VoyageAI documentation.
bit is a synonym of binary in the VoyageAI documentation.
Only for the text_embedding task type.
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 to document in the VoyageAI documentation), search (maps to query in the VoyageAI documentation).
Only for the text_embedding task type.
return_documentsboolean · default: false
Whether to return the source documents in the response.
Only for the rerank task 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 rerank task type.
truncationboolean · default: true
Whether to truncate the input texts to fit within the context length.
The maximum size of a chunk in words.
This value cannot be higher than 300 or lower than 20 (for sentence strategy) or 10 (for word strategy).
overlapnumber · default: 100
The number of overlapping words for chunks.
It is applicable only to a word chunking strategy.
This value cannot be higher than half the max_chunk_size value.
sentence_overlapnumber · default: 1
The number of overlapping sentences for chunks.
It is applicable only for a sentence chunking strategy.
It can be either 1 or 0.
strategystring · default: sentence
The chunking strategy: sentence or word.
servicestringrequired
The service type
service_settingsobjectrequired
Settings specific to the service
task_settingsobject
Task settings specific to the service and task type