Visitor 1.0.0 API

All Implemented Interfaces:


public interface ResponseCreateParams.ToolChoice.Visitor<T extends Object>

An interface that defines how to map each variant of ToolChoice to a value of type T.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract T`	`visitOptions(ToolChoiceOptions options)`	Controls which (if any) tool is called by the model.
`abstract T`	`visitTypes(ToolChoiceTypes types)`	Indicates that the model should use a built-in tool to generate a response.
`abstract T`	`visitFunction(ToolChoiceFunction function)`	Use this option to force the model to call a specific function.
`T`	`unknown(JsonValue json)`	Maps an unknown variant of ToolChoice to a value of type T.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - visitOptions
```
 abstract T visitOptions(ToolChoiceOptions options)
```
    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.
  - visitTypes
```
 abstract T visitTypes(ToolChoiceTypes types)
```
    Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
  - visitFunction
```
 abstract T visitFunction(ToolChoiceFunction function)
```
    Use this option to force the model to call a specific function.
  - 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.