FileSearchTool Class

A tool that searches for uploaded file information from the created vector stores.

Constructor

FileSearchTool(vector_store_ids: List[str] | None = None)

Parameters

Name	Description
vector_store_ids	list[str] A list of vector store IDs to search for files. Default value: None

Methods

add_vector_store	Add a vector store ID to the list of vector stores to search for files.
execute
remove_vector_store	Remove a vector store ID from the list of vector stores to search for files.

add_vector_store

Add a vector store ID to the list of vector stores to search for files.

add_vector_store(store_id: str) -> None

Parameters

Name	Description
store_id Required	str The ID of the vector store to search for files.

execute

execute(tool_call: Any) -> Any

Parameters

Name	Description
tool_call Required

remove_vector_store

Remove a vector store ID from the list of vector stores to search for files.

remove_vector_store(store_id: str) -> None

Parameters

Name	Description
store_id Required	str The ID of the vector store to remove.

Attributes

definitions

Get the file search tool definitions.

Returns

Type	Description
List[ToolDefinition]

resources

Get the file search resources.

Returns

Type	Description
ToolResources