Constructor Detail

Method Detail

• auto

   final Optional<AssistantToolChoiceOption.Auto> auto()

  none means the model will not call any tools 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 before responding to the user.

• assistantToolChoice

   final Optional<AssistantToolChoice> assistantToolChoice()

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

• isAuto

   final Boolean isAuto()

• isAssistantToolChoice

   final Boolean isAssistantToolChoice()

• asAuto

   final AssistantToolChoiceOption.Auto asAuto()

  none means the model will not call any tools 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 before responding to the user.

• asAssistantToolChoice

   final AssistantToolChoice asAssistantToolChoice()

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

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(AssistantToolChoiceOption.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 = assistantToolChoiceOption.accept(new AssistantToolChoiceOption.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 AssistantToolChoiceOption 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 AssistantToolChoiceOption ofAuto(AssistantToolChoiceOption.Auto auto)

  none means the model will not call any tools 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 before responding to the user.

• ofAssistantToolChoice

   final static AssistantToolChoiceOption ofAssistantToolChoice(AssistantToolChoice assistantToolChoice)

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