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

Module for representing the OpenAI schema AssistantToolsFileSearch.

Fields

  • :file_search - optional - {:%{}, [], [{{:optional, [], [:max_num_results]}, {:integer, [], []}}, {{:optional, [], [:ranking_options]}, {{:., [], [ExOpenAI.Components.FileSearchRankingOptions, :t]}, [], []}}]}
    Overrides for the file search tool.

  • :type - required - :file_search
    The type of tool being defined: file_search
    Allowed values: "file_search"

Summary

Types

t()

Types

Link to this type

t()

View Source 
@type t() :: %ExOpenAI.Components.AssistantToolsFileSearch{
  file_search:
    %{
      optional(:max_num_results) => integer(),
      optional(:ranking_options) =>
        ExOpenAI.Components.FileSearchRankingOptions.t()
    }
    | nil,
  type: :file_search
}