Execute an agent

Introduced 2.12

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.

When an agent is executed, it runs the tools with which it is configured.

Path and HTTP methods

  1. POST /_plugins/_ml/agents/<agent_id>/_execute

Request fields

The following table lists the available request fields.

FieldData typeRequired/OptionalDescription
parametersObjectRequiredThe parameters required by the agent.
parameters.verboseBooleanOptionalProvides verbose output.

Example request

  1. POST /_plugins/_ml/agents/879v9YwBjWKCe6Kg12Tx/_execute
  2. {
  3. "parameters": {
  4. "question": "what's the population increase of Seattle from 2021 to 2023"
  5. }
  6. }

copy

Example response

  1. {
  2. "inference_results": [
  3. {
  4. "output": [
  5. {
  6. "result": """ Based on the given context, the key information is:
  7. The metro area population of Seattle in 2021 was 3,461,000.
  8. The metro area population of Seattle in 2023 is 3,519,000.
  9. To calculate the population increase from 2021 to 2023:
  10. Population in 2023 (3,519,000) - Population in 2021 (3,461,000) = 58,000
  11. Therefore, the population increase of Seattle from 2021 to 2023 is 58,000."""
  12. }
  13. ]
  14. }
  15. ]
  16. }