Get an inference endpoint
- GET /_inference/{task_type}/{inference_id}
- GET /_inference/{task_type}/_all
- GET /_inference/{inference_id}
- GET /_inference
Path Parameters
-
task_typeTaskTypeoptional -
The task type of the endpoint to return
Leave it out to use
/_inference. -
Values:
sparse_embeddingtext_embeddingrerankcompletionchat_completion -
inference_idstring Idoptional -
The inference Id of the endpoint to return. Using
_allor*will return all endpoints with the specifiedtask_typeif one is specified, or all endpoints for all task types if notask_typeis specifiedLeave it out to use
/_inference.
Response
-
endpointsInferenceEndpointInforequired -
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
-
task_typeTaskTyperequired -
The task type
-
Values:
sparse_embeddingtext_embeddingrerankcompletionchat_completion