Skip to content

Commit

Permalink
add doc for nested_path
Browse files Browse the repository at this point in the history
Signed-off-by: zhichao-aws <[email protected]>
  • Loading branch information
zhichao-aws committed Jul 17, 2024
1 parent e3ee238 commit 91891ae
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 0 deletions.
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
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
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

0 comments on commit 91891ae

Please sign in to comment.