fileSearchTool method

OpenAIBuilder fileSearchTool({
  1. List<String>? vectorStoreIds,
  2. Map<String, dynamic>? parameters,
})

Adds file search built-in tool

Enables the model to search through documents in vector stores. Only available with Responses API.

Example:

final provider = await ai()
    .openai((openai) => openai
        .useResponsesAPI()
        .fileSearchTool(vectorStoreIds: ['vs_123', 'vs_456']))
    .build();

Implementation

OpenAIBuilder fileSearchTool({
  List<String>? vectorStoreIds,
  Map<String, dynamic>? parameters,
}) {
  final tools = _getBuiltInTools();
  tools.add(OpenAIBuiltInTools.fileSearch(
    vectorStoreIds: vectorStoreIds,
    parameters: parameters,
  ));
  _baseBuilder.extension('builtInTools', tools);
  return this;
}