Enum BuiltInToolChoiceType 

pub enum BuiltInToolChoiceType {
    FileSearch,
    WebSearch,
    WebSearchPreview,
    WebSearchPreview20250311,
    ImageGeneration,
    ComputerUsePreview,
    CodeInterpreter,
}

Built-in (hosted) tool types that can be referenced directly by tool_choice: {"type": "..."} in the Responses API.

Each variant is a distinct string per the spec — we keep multiple web_search_preview* forms because the spec enumerates them separately and older clients may still send the versioned aliases.

Variants

FileSearch

WebSearch

WebSearchPreview

WebSearchPreview20250311

ImageGeneration

ComputerUsePreview

CodeInterpreter

Trait Implementations

impl Clone for BuiltInToolChoiceType

fn clone(&self) -> BuiltInToolChoiceType

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for BuiltInToolChoiceType

impl Debug for BuiltInToolChoiceType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BuiltInToolChoiceType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BuiltInToolChoiceType

impl JsonSchema for BuiltInToolChoiceType

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for BuiltInToolChoiceType

fn eq(&self, other: &BuiltInToolChoiceType) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for BuiltInToolChoiceType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BuiltInToolChoiceType