Perform completion inference on the service

Auth

Get responses for completion tasks. This API works only with the completion task type.

Important

The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

This API requires the monitor_inference cluster privilege (the built-in inference_admin and inference_user roles grant this privilege).

Path parameters

inference_id string required

The inference Id

Query parameters

timeout string · default: 120s

Specifies the amount of time to wait for the inference request to complete.

Request body

input union string | string[] required

Inference input. Either a string or an array of strings.

task_settings object

Task settings for the individual inference request. These settings are specific to the <task_type> you specified and override the task settings specified when initializing the service.

Response

application/json
completion object[] required
result string required