FileSearchTool interface

Package:

@azure/ai-projects

A tool that searches for relevant content from uploaded files. Learn more about the file search tool.

Extends

Tool

Properties

description	Deprecated. This property is deprecated and will be removed in a future version.
filters	Filters to apply to the file search.
max_num_results	The maximum number of results to return. This number should be between 1 and 50 inclusive.
name	Deprecated. This property is deprecated and will be removed in a future version.
ranking_options	Ranking options for search.
tool_configs	Deprecated. This property is deprecated and will be removed in a future version.
type	The type of the file search tool. Always file_search.
vector_store_ids	The IDs of the vector stores to search.

Property Details

description

Deprecated. This property is deprecated and will be removed in a future version.

description?: string

Property Value

string

filters

Filters to apply to the file search.

filters?: Filters

Property Value

Filters

max_num_results

The maximum number of results to return. This number should be between 1 and 50 inclusive.

max_num_results?: number

Property Value

number

name

Deprecated. This property is deprecated and will be removed in a future version.

name?: string

Property Value

string

ranking_options

Ranking options for search.

ranking_options?: RankingOptions

Property Value

RankingOptions

tool_configs

Deprecated. This property is deprecated and will be removed in a future version.

tool_configs?: Record<string, ToolConfig>

Property Value

Record<string, ToolConfig>

type

The type of the file search 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[]