FileSearchToolboxTool interface

Uma ferramenta de busca de arquivos armazenada em uma caixa de ferramentas.

Extends

Propriedades

filters

Filtros que restringem quais arquivos estão incluídos na busca.

max_num_results

O número máximo de resultados a serem retornados. Esse número deve estar entre 1 e 50, inclusive.

ranking_options

Opções de classificação para pesquisa.

type

O tipo da ferramenta de busca de arquivos. Sempre file_search.

vector_store_ids

Os IDs dos repositórios de vetores a serem pesquisados.

Propriedades herdadas

description

Descrição opcional definida pelo usuário para esta ferramenta ou configuração.

name

Nome opcional definido pelo usuário para essa ferramenta ou configuração.

tool_configs

Mapa de configuração por ferramenta. Chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados durante a execução.

Detalhes da propriedade

filters

Filtros que restringem quais arquivos estão incluídos na busca.

filters?: Filters

Valor da propriedade

max_num_results

O número máximo de resultados a serem retornados. Esse número deve estar entre 1 e 50, inclusive.

max_num_results?: number

Valor da propriedade

number

ranking_options

Opções de classificação para pesquisa.

ranking_options?: RankingOptions

Valor da propriedade

type

O tipo da ferramenta de busca de arquivos. Sempre file_search.

type: "file_search"

Valor da propriedade

"file_search"

vector_store_ids

Os IDs dos repositórios de vetores a serem pesquisados.

vector_store_ids?: string[]

Valor da propriedade

string[]

Detalhes das propriedades herdadas

description

Descrição opcional definida pelo usuário para esta ferramenta ou configuração.

description?: string

Valor da propriedade

string

Herdado deToolboxTool.description

name

Nome opcional definido pelo usuário para essa ferramenta ou configuração.

name?: string

Valor da propriedade

string

Herdado deToolboxTool.name

tool_configs

Mapa de configuração por ferramenta. Chaves são nomes de ferramentas ou * (padrão abrangente). Ordem de resolução: a correspondência exata do nome da ferramenta tem prioridade sobre *. Nomes de ferramentas desconhecidos são silenciosamente ignorados durante a execução.

tool_configs?: Record<string, ToolConfig>

Valor da propriedade

Record<string, ToolConfig>

Herdado deToolboxTool.tool_configs