Enum ToolChoiceParam 

pub enum ToolChoiceParam {
    ToolChoiceOptions(ToolChoiceOptions),
    ToolChoiceAllowed(ToolChoiceAllowed),
    ToolChoiceTypes(ToolChoiceTypes),
    ToolChoiceFunction(ToolChoiceFunction),
    ToolChoiceMcp(ToolChoiceMcp),
    ToolChoiceCustom(ToolChoiceCustom),
    SpecificApplyPatchParam(SpecificApplyPatchParam),
    SpecificFunctionShellParam(SpecificFunctionShellParam),
}

How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

JSON schema

{
 "description": "How the model should select which tool (or tools) to use when generating\na response. See the `tools` parameter to see how to specify which tools\nthe model can call.\n",
 "oneOf": [
   {
     "$ref": "#/components/schemas/ToolChoiceOptions"
   },
   {
     "$ref": "#/components/schemas/ToolChoiceAllowed"
   },
   {
     "$ref": "#/components/schemas/ToolChoiceTypes"
   },
   {
     "$ref": "#/components/schemas/ToolChoiceFunction"
   },
   {
     "$ref": "#/components/schemas/ToolChoiceMCP"
   },
   {
     "$ref": "#/components/schemas/ToolChoiceCustom"
   },
   {
     "$ref": "#/components/schemas/SpecificApplyPatchParam"
   },
   {
     "$ref": "#/components/schemas/SpecificFunctionShellParam"
   }
 ]
}

Variants

ToolChoiceOptions(ToolChoiceOptions)

ToolChoiceAllowed(ToolChoiceAllowed)

ToolChoiceTypes(ToolChoiceTypes)

ToolChoiceFunction(ToolChoiceFunction)

ToolChoiceMcp(ToolChoiceMcp)

ToolChoiceCustom(ToolChoiceCustom)

SpecificApplyPatchParam(SpecificApplyPatchParam)

SpecificFunctionShellParam(SpecificFunctionShellParam)

Trait Implementations

impl Clone for ToolChoiceParam

fn clone(&self) -> ToolChoiceParam

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolChoiceParam

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolChoiceParam

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<SpecificApplyPatchParam> for ToolChoiceParam

fn from(value: SpecificApplyPatchParam) -> Self

Converts to this type from the input type.

impl From<SpecificFunctionShellParam> for ToolChoiceParam

fn from(value: SpecificFunctionShellParam) -> Self

Converts to this type from the input type.

impl From<ToolChoiceAllowed> for ToolChoiceParam

fn from(value: ToolChoiceAllowed) -> Self

Converts to this type from the input type.

impl From<ToolChoiceCustom> for ToolChoiceParam

fn from(value: ToolChoiceCustom) -> Self

Converts to this type from the input type.

impl From<ToolChoiceFunction> for ToolChoiceParam

fn from(value: ToolChoiceFunction) -> Self

Converts to this type from the input type.

impl From<ToolChoiceMcp> for ToolChoiceParam

fn from(value: ToolChoiceMcp) -> Self

Converts to this type from the input type.

impl From<ToolChoiceOptions> for ToolChoiceParam

fn from(value: ToolChoiceOptions) -> Self

Converts to this type from the input type.

impl From<ToolChoiceTypes> for ToolChoiceParam

fn from(value: ToolChoiceTypes) -> Self

Converts to this type from the input type.

impl Serialize for ToolChoiceParam

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

where __S: Serializer,

Serialize this value into the given Serde serializer.