Constructor Detail

Method Detail

• visitBetaToolChoiceOptions

   abstract T visitBetaToolChoiceOptions(BetaToolChoiceOptions betaToolChoiceOptions)

  Controls which (if any) tool is called by the model.

  none means the model will not call any tool and instead generates a message.

  auto means the model can pick between generating a message or calling one or more tools.

  required means the model must call one or more tools.

• visitBetaToolChoiceAllowed

   abstract T visitBetaToolChoiceAllowed(BetaToolChoiceAllowed betaToolChoiceAllowed)

  Constrains the tools available to the model to a pre-defined set.

• visitBetaToolChoiceTypes

   abstract T visitBetaToolChoiceTypes(BetaToolChoiceTypes betaToolChoiceTypes)

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

• visitBetaToolChoiceFunction

   abstract T visitBetaToolChoiceFunction(BetaToolChoiceFunction betaToolChoiceFunction)

  Use this option to force the model to call a specific function.

• visitBetaToolChoiceMcp

   abstract T visitBetaToolChoiceMcp(BetaToolChoiceMcp betaToolChoiceMcp)

  Use this option to force the model to call a specific tool on a remote MCP server.

• visitBetaToolChoiceCustom

   abstract T visitBetaToolChoiceCustom(BetaToolChoiceCustom betaToolChoiceCustom)

  Use this option to force the model to call a specific custom tool.

• visitBetaSpecificProgrammaticToolCallingParam

   abstract T visitBetaSpecificProgrammaticToolCallingParam(JsonValue betaSpecificProgrammaticToolCallingParam)

• visitBetaToolChoiceApplyPatch

   abstract T visitBetaToolChoiceApplyPatch(BetaToolChoiceApplyPatch betaToolChoiceApplyPatch)

  Forces the model to call the apply_patch tool when executing a tool call.

• visitBetaToolChoiceShell

   abstract T visitBetaToolChoiceShell(BetaToolChoiceShell betaToolChoiceShell)

  Forces the model to call the shell tool when a tool call is required.

• unknown

   T unknown(JsonValue json)

  Maps an unknown variant of ToolChoice to a value of type T.

  An instance of ToolChoice can contain an unknown variant if it was deserialized from data that doesn't match any known variant. For example, if the SDK is on an older version than the API, then the API may respond with new variants that the SDK is unaware of.