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

Hosted or BYOT tool search configuration for deferred tools.

Fields

  • :description - optional - String.t() | any()

  • :execution - optional - ExOpenAI.Components.ToolSearchExecutionType.t()
    Whether tool search is executed by the server or by the client.

  • :parameters - optional - ExOpenAI.Components.EmptyModelParam.t() | any()

  • :type - required - :tool_search
    The type of the tool. Always tool_search.
    Allowed values: "tool_search"
    Default: "tool_search"

Summary

Types

@type t() :: %ExOpenAI.Components.ToolSearchToolParam{
  description: (String.t() | any()) | nil,
  execution: ExOpenAI.Components.ToolSearchExecutionType.t() | nil,
  parameters: (ExOpenAI.Components.EmptyModelParam.t() | any()) | nil,
  type: :tool_search
}