Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions _ml-commons-plugin/agents-tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,5 @@ An _agent_ orchestrates and runs ML models and tools. For a list of supported ag

A _tool_ performs a set of specific tasks. Some examples of tools are the [`VectorDBTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/vector-db-tool/), which supports vector search, and the [`ListIndexTool`]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/list-index-tool/), which executes the List Indices API. For a list of supported tools, see [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/).

You can modify and transform tool outputs using [processor chain]({{site.url}}{{site.baseurl}}/ml-commons-plugin/processor-chain/).

1 change: 1 addition & 0 deletions _ml-commons-plugin/api/agent-apis/register-agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Field | Data type | Required/Optional | Description
`name`| String | Optional | The tool name. The tool name defaults to the `type` parameter value. If you need to include multiple tools of the same type in an agent, specify different names for the tools. |
`description`| String | Optional | The tool description. Defaults to a built-in description for the specified type. |
`parameters` | Object | Optional | The parameters for this tool. The parameters are highly dependent on the tool type. You can find information about specific tool types in [Tools]({{site.url}}{{site.baseurl}}/ml-commons-plugin/agents-tools/tools/index/).
`parameters.output_processors` | Array | Optional | A list of processors to transform the tool's output. For more information, see [Processor Chain]({{site.url}}{{site.baseurl}}/ml-commons-plugin/processor-chain/).
`attributes.input_schema` | Object | Optional | The expected input format for this tool defined as a [JSON schema](https://json-schema.org/). Used to define the structure the LLM should follow when calling the tool.
`attributes.strict` | Boolean | Optional | Whether function calling reliably adheres to the input schema or not.

Expand Down
12 changes: 12 additions & 0 deletions _ml-commons-plugin/api/train-predict/predict.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,18 @@ For information about user access for this API, see [Model access control consid
POST /_plugins/_ml/_predict/<algorithm_name>/<model_id>
```

## Request body fields

The following table lists the available request fields.

Field | Data type | Required/Optional | Description
:--- | :--- | :--- | :---
`parameters` | Object | Optional | Model-specific parameters for prediction.
`parameters.input_processors` | Array | Optional | A list of processors to transform the input data before sending it to the model. For more information, see [Processor Chain]({{site.url}}{{site.baseurl}}/ml-commons-plugin/processor-chain/).
`parameters.output_processors` | Array | Optional | A list of processors to transform the model's output data. For more information, see [Processor Chain]({{site.url}}{{site.baseurl}}/ml-commons-plugin/processor-chain/).

For remote models, the actual input fields depend on the model's connector configuration. For more information, see [Connectors]({{site.url}}{{site.baseurl}}/ml-commons-plugin/remote-models/connectors/).

## Example request

```json
Expand Down
Loading
Loading