FileSearchToolboxTool interface
A file search tool stored in a toolbox.
- Extends
Properties
| filters | Filters that restrict which files are included in the search. |
| max_num_results | The maximum number of results to return. This number should be between 1 and 50 inclusive. |
| ranking_options | Ranking options for search. |
| type | The type of the file search toolbox tool. Always |
| vector_store_ids | The IDs of the vector stores to search. |
Inherited Properties
| description | Optional user-defined description for this tool or configuration. |
| name | Optional user-defined name for this tool or configuration. |
| tool_configs | Per-tool configuration map. Keys are tool names or |
Property Details
filters
Filters that restrict which files are included in the search.
filters?: FiltersProperty Value
max_num_results
The maximum number of results to return. This number should be between 1 and 50 inclusive.
max_num_results?: numberProperty Value
number
ranking_options
type
The type of the file search toolbox tool. Always file_search.
type: "file_search"Property Value
"file_search"
vector_store_ids
The IDs of the vector stores to search.
vector_store_ids?: string[]Property Value
string[]
Inherited Property Details
description
Optional user-defined description for this tool or configuration.
description?: stringProperty Value
string
Inherited From ToolboxTool.description
name
Optional user-defined name for this tool or configuration.
name?: stringProperty Value
string
Inherited From ToolboxTool.name
tool_configs
Per-tool configuration map. Keys are tool names or * (catch-all default).
Resolution order: exact tool name match takes priority over *.
Unknown tool names are silently ignored at runtime.
tool_configs?: Record<string, ToolConfig>Property Value
Record<string, ToolConfig>
Inherited From ToolboxTool.tool_configs