Perform dense embedding inference on the service

Auth

Required privileges

Cluster privileges monitor_inference

Path parameters

inference_id string required

The inference Id

Query parameters

timeout string · default: 30s

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

Request body

input union oneOf required

Inference input. Either a string, an array of strings, a content object, or an array of content objects. content objects may contain a single item or an array of items. Models that support multiple items per content object will return a single embedding for each content object, regardless of how many items it contains. Support for multiple items in a single content object is available in Elasticsearch 9.5.0 and later.

string example:

"input": "Some text"

string array example:

"input": ["Some text", "Some more text"]

content object example:

"input": {
    "content": {
      "type": "image",
      "format": "base64",
      "value": "data:image/jpeg;base64,..."
    }
  }

content object array example:

"input": [
  {
    "content": {
      "type": "text",
      "format": "text",
      "value": "Some text to generate an embedding"
    }
  },
  {
    "content": {
      "type": "image",
      "format": "base64",
      "value": "data:image/jpeg;base64,..."
    }
  }
]

content object using the url format example (available in Elasticsearch 9.6.0 and later):

"input": {
    "content": {
      "type": "image",
      "format": "url",
      "value": "https://example.com/image.jpg"
    }
  }

Multiple items in one content object example (available in Elasticsearch 9.5.0 and later):

"input": [
  {
    "content": [
      {
        "type": "image",
        "format": "base64",
        "value": "data:image/jpeg;base64,..."
      },
      {
        "type": "text",
        "value": "Some text to create an embedding"
      }
    ]
  }
]
One of:

Allows specifying text-only inputs for the embedding task.

input_type string

The input data type for the embedding model. Possible values include:

  • SEARCH
  • INGEST
  • CLASSIFICATION
  • CLUSTERING

Not all models support all values. Unsupported values will trigger a validation exception. Accepted values depend on the configured inference service, refer to the relevant service-specific documentation for more info.

Note

The input_type parameter specified on the root level of the request body will take precedence over the input_type parameter specified in task_settings.

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
embeddings_bytes object[]
embedding number[] required
embeddings_bits object[]
embedding number[] required
embeddings object[]
embedding number[] required