Constructor Detail

Method Detail

• auto

   final Optional<ChatCompletionToolChoiceOption.Auto> auto()

  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.

• allowedToolChoice

   final Optional<ChatCompletionAllowedToolChoice> allowedToolChoice()

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

• namedToolChoice

   final Optional<ChatCompletionNamedToolChoice> namedToolChoice()

  Specifies a tool the model should use. Use to force the model to call a specific function.

• namedToolChoiceCustom

   final Optional<ChatCompletionNamedToolChoiceCustom> namedToolChoiceCustom()

  Specifies a tool the model should use. Use to force the model to call a specific custom tool.

• isAuto

   final Boolean isAuto()

• isAllowedToolChoice

   final Boolean isAllowedToolChoice()

• isNamedToolChoice

   final Boolean isNamedToolChoice()

• isNamedToolChoiceCustom

   final Boolean isNamedToolChoiceCustom()

• asAuto

   final ChatCompletionToolChoiceOption.Auto asAuto()

  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.

• asAllowedToolChoice

   final ChatCompletionAllowedToolChoice asAllowedToolChoice()

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

• asNamedToolChoice

   final ChatCompletionNamedToolChoice asNamedToolChoice()

  Specifies a tool the model should use. Use to force the model to call a specific function.

• asNamedToolChoiceCustom

   final ChatCompletionNamedToolChoiceCustom asNamedToolChoiceCustom()

  Specifies a tool the model should use. Use to force the model to call a specific custom tool.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ChatCompletionToolChoiceOption.Visitor<T> visitor)

  Maps this instance's current variant to a value of type T using the given visitor.

  Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:

  import com.openai.core.JsonValue;
  import java.util.Optional;
  
  Optional<String> result = chatCompletionToolChoiceOption.accept(new ChatCompletionToolChoiceOption.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitAuto(Auto auto) {
          return Optional.of(auto.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final ChatCompletionToolChoiceOption validate()

  Validates that the types of all values in this object match their expected types recursively.

  This method is not forwards compatible with new types from the API for existing fields.

• isValid

   final Boolean isValid()

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• ofAuto

   final static ChatCompletionToolChoiceOption ofAuto(ChatCompletionToolChoiceOption.Auto auto)

  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.

• ofAllowedToolChoice

   final static ChatCompletionToolChoiceOption ofAllowedToolChoice(ChatCompletionAllowedToolChoice allowedToolChoice)

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

• ofNamedToolChoice

   final static ChatCompletionToolChoiceOption ofNamedToolChoice(ChatCompletionNamedToolChoice namedToolChoice)

  Specifies a tool the model should use. Use to force the model to call a specific function.

• ofNamedToolChoiceCustom

   final static ChatCompletionToolChoiceOption ofNamedToolChoiceCustom(ChatCompletionNamedToolChoiceCustom namedToolChoiceCustom)

  Specifies a tool the model should use. Use to force the model to call a specific custom tool.