search_onyx
Search the Onyx backend to retrieve relevant document chunks or full documents based on a query. Customize results by specifying document sets, surrounding chunks, and max results for precise information retrieval.
Instructions
Search the Onyx backend for relevant documents
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| chunksAbove | No | Number of chunks to include above the matching chunk (default: 1) | |
| chunksBelow | No | Number of chunks to include below the matching chunk (default: 1) | |
| documentSets | No | List of document set names to search within (empty for all) | |
| maxResults | No | Maximum number of results to return (default: 5) | |
| query | Yes | The topic to search for | |
| retrieveFullDocuments | No | Whether to retrieve full documents instead of just matching chunks (default: false) |
Input Schema (JSON Schema)
{
"properties": {
"chunksAbove": {
"default": 1,
"description": "Number of chunks to include above the matching chunk (default: 1)",
"type": "integer"
},
"chunksBelow": {
"default": 1,
"description": "Number of chunks to include below the matching chunk (default: 1)",
"type": "integer"
},
"documentSets": {
"description": "List of document set names to search within (empty for all)",
"items": {
"type": "string"
},
"type": "array"
},
"maxResults": {
"description": "Maximum number of results to return (default: 5)",
"maximum": 10,
"minimum": 1,
"type": "integer"
},
"query": {
"description": "The topic to search for",
"type": "string"
},
"retrieveFullDocuments": {
"default": false,
"description": "Whether to retrieve full documents instead of just matching chunks (default: false)",
"type": "boolean"
}
},
"required": [
"query"
],
"type": "object"
}