Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the nested_path parameter in agent search tools #7741

Merged
merged 1 commit into from
Jul 22, 2024
Merged

Document the nested_path parameter in agent search tools #7741

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions _ml-commons-plugin/agents-tools/tools/neural-sparse-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ Parameter | Type | Required/Optional | Description
`name` | String | Optional | The tool name. Useful when an LLM needs to select an appropriate tool for a task.
`description` | String | Optional | A description of the tool. Useful when an LLM needs to select an appropriate tool for a task.
`doc_size` | Integer | Optional | The number of documents to fetch. Default is `2`.
`nested_path` | String | Optional | The path to the nested object for the nested query. Only used for nested fields. Default is `null`.

## Execute parameters

Expand Down
1 change: 1 addition & 0 deletions _ml-commons-plugin/agents-tools/tools/rag-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ Parameter | Type | Required/Optional | Description
`prompt` | String | Optional | The prompt to provide to the LLM.
`k` | Integer | Optional | The number of nearest neighbors to search for when performing neural search. Default is 10.
`enable_Content_Generation` | Boolean | Optional | If `true`, returns results generated by an LLM. If `false`, returns results directly without LLM-assisted content generation. Default is `true`.
`nested_path` | String | Optional | The path to the nested object for the nested query. Only used for nested fields. Default is `null`.

## Execute parameters

Expand Down
1 change: 1 addition & 0 deletions _ml-commons-plugin/agents-tools/tools/vector-db-tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ Parameter | Type | Required/Optional | Description
`input` | String | Required for flow agent | Runtime input sourced from flow agent parameters. If using a large language model (LLM), this field is populated with the LLM response.
`doc_size` | Integer | Optional | The number of documents to fetch. Default is `2`.
`k` | Integer | Optional | The number of nearest neighbors to search for when performing neural search. Default is `10`.
`nested_path` | String | Optional | The path to the nested object for the nested query. Only used for nested fields. Default is `null`.

## Execute parameters

Expand Down
Loading