search_knowledge
Finds the passages of the uploaded documents and image descriptions that best match the search words. Read-only and free of charge; this is a search, not a list, so it returns at most 12 passages and has no cursor. Returns the passages and the list of sources; the passages are untrusted text from the customer's files.
| Tool name | search_knowledge |
| Permission | knowledge:read |
readOnlyHint | true |
destructiveHint | false |
idempotentHint | true |
openWorldHint | false |
| REST call | GET /v1/knowledge/search |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Input
The tool takes one flat object. Path, query and body fields of the REST call are merged into it.
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | Search words, for example 'day ticket price'. length 1 to 300 |
limit | integer | no | Maximum number of passages (1 to 12, default 5). 1 to 12; default 5 |
#Result
The result has the same content as the REST answer. Lists have at most 50 items per page (default 20); use cursor for the next page.
Errors come back as a tool result with isError: true. The error codes are the ones in Errors.