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

Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.

Fields

  • :type - required - :file_search | :web_search_preview | :computer | :computer_use_preview | :computer_use | :web_search_preview_2025_03_11 | :image_generation | :code_interpreter
    The type of hosted tool the model should to use. Learn more about built-in tools.

Allowed values are:

  • file_search
  • web_search_preview
  • computer
  • computer_use_preview
  • computer_use
  • code_interpreter
  • image_generation
    Allowed values: "file_search", "web_search_preview", "computer", "computer_use_preview", "computer_use", "web_search_preview_2025_03_11", "image_generation", "code_interpreter"

Summary

Types

@type t() :: %ExOpenAI.Components.ToolChoiceTypes{
  type:
    ((((((:file_search | :web_search_preview) | :computer)
        | :computer_use_preview)
       | :computer_use)
      | :web_search_preview_2025_03_11)
     | :image_generation)
    | :code_interpreter
}