AuthThe Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.AvailabilityGenerally available since 8.18This 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 jinaai service.
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, jinaai.
Values:jinaai
service_settingsobjectrequired
Settings used to install the inference model. These settings are specific to the jinaai service.
api_keystringrequired
A valid API key of your JinaAI account.
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.
The name of the model to use for the inference task.
rate_limitobject
This setting helps to minimize the number of rate limit errors returned from JinaAI.
By default, the jinaai service sets the number of requests allowed per minute to 2000 for all task types.
For a text_embedding task, the similarity measure. One of cosine, dot_product, l2_norm.
The default values varies with the embedding type.
For example, a float embedding type uses a dot_product similarity measure by default.
Values:cosinedot_productl2_norm
dimensionsnumber
For a text_embedding task, the number of dimensions the resulting output embeddings should have.
By default, the model's standard output dimension is used.
Refer to the Jina documentation for more information.
For a text_embedding task, the data type returned by the model.
Use bit for binary embeddings, which are encoded as bytes with signed int8 precision.
Use binary for binary embeddings, which are encoded as bytes with signed int8 precision (this is a synonym of bit).
Use float for the default float embeddings.
Values:binarybitfloat
task_settingsobject
Settings to configure the inference task.
These settings are specific to the task type you specified.
return_documentsboolean
For a rerank task, return the doc text within the results.
taskenum
For a text_embedding task, the task passed to the model.
Valid values are:
classification: Use it for embeddings passed through a text classifier.
clustering: Use it for the embeddings run through a clustering algorithm.
ingest: Use it for storing document embeddings in a vector database.
search: Use it for storing embeddings of search queries run against a vector database to find relevant documents.
Values:classificationclusteringingestsearch
top_nnumber
For a rerank task, the number of most relevant documents to return.
It defaults to the number of the documents.
If this inference endpoint is used in a text_similarity_reranker retriever query and top_n is set, it must be greater than or equal to rank_window_size in the query.
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