Constructor Detail

Method Detail

• toolChoiceOptions

   final Optional<ToolChoiceOptions> toolChoiceOptions()

  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.

• toolChoiceFunction

   final Optional<ToolChoiceFunction> toolChoiceFunction()

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

• toolChoiceMcp

   final Optional<ToolChoiceMcp> toolChoiceMcp()

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

• isToolChoiceOptions

   final Boolean isToolChoiceOptions()

• isToolChoiceFunction

   final Boolean isToolChoiceFunction()

• isToolChoiceMcp

   final Boolean isToolChoiceMcp()

• asToolChoiceOptions

   final ToolChoiceOptions asToolChoiceOptions()

  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.

• asToolChoiceFunction

   final ToolChoiceFunction asToolChoiceFunction()

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

• asToolChoiceMcp

   final ToolChoiceMcp asToolChoiceMcp()

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

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(RealtimeToolChoiceConfig.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 = realtimeToolChoiceConfig.accept(new RealtimeToolChoiceConfig.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitToolChoiceOptions(ToolChoiceOptions toolChoiceOptions) {
          return Optional.of(toolChoiceOptions.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final RealtimeToolChoiceConfig 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()

• ofToolChoiceOptions

   final static RealtimeToolChoiceConfig ofToolChoiceOptions(ToolChoiceOptions toolChoiceOptions)

  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.

• ofToolChoiceFunction

   final static RealtimeToolChoiceConfig ofToolChoiceFunction(ToolChoiceFunction toolChoiceFunction)

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

• ofToolChoiceMcp

   final static RealtimeToolChoiceConfig ofToolChoiceMcp(ToolChoiceMcp toolChoiceMcp)

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