View Source ExOpenAI.Components.FileSearchTool (ex_openai.ex v2.0.0-beta2)

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

Fields

  • :filters - optional - ExOpenAI.Components.Filters.t() | any()

  • :max_num_results - optional - integer()
    The maximum number of results to return. This number should be between 1 and 50 inclusive.

  • :ranking_options - optional - ExOpenAI.Components.RankingOptions.t()
    Ranking options for search.

  • :type - required - :file_search
    The type of the file search tool. Always file_search.
    Allowed values: "file_search"
    Default: "file_search"

  • :vector_store_ids - required - [String.t()]
    The IDs of the vector stores to search.

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.FileSearchTool{
  filters: (ExOpenAI.Components.Filters.t() | any()) | nil,
  max_num_results: integer() | nil,
  ranking_options: ExOpenAI.Components.RankingOptions.t() | nil,
  type: :file_search,
  vector_store_ids: [String.t()]
}