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

Module for representing the OpenAI schema RunStepDetailsToolCallsFileSearchObject.

Fields

:file_search - required - {:%{}, [], [{{:optional, [], [:ranking_options]}, {{:., [], [ExOpenAI.Components.RunStepDetailsToolCallsFileSearchRankingOptionsObject, :t]}, [], []}}, {{:optional, [], [:results]}, {:list, [], [{{:., [], [ExOpenAI.Components.RunStepDetailsToolCallsFileSearchResultObject, :t]}, [], []}]}}]}
For now, this is always going to be an empty object.
:id - required - String.t()
The ID of the tool call object.
:type - required - :file_search
The type of tool call. This is always going to be file_search for this type of tool call.
Allowed values: "file_search"

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.RunStepDetailsToolCallsFileSearchObject{
  file_search: %{
    optional(:ranking_options) =>
      ExOpenAI.Components.RunStepDetailsToolCallsFileSearchRankingOptionsObject.t(),
    optional(:results) => [
      ExOpenAI.Components.RunStepDetailsToolCallsFileSearchResultObject.t()
    ]
  },
  id: String.t(),
  type: :file_search
}