Constructor Detail

Method Detail

• options

   final Optional<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.

• function

   final Optional<ToolChoiceFunction> function()

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

• mcp

   final Optional<ToolChoiceMcp> mcp()

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

• isOptions

   final Boolean isOptions()

• isFunction

   final Boolean isFunction()

• isMcp

   final Boolean isMcp()

• asOptions

   final ToolChoiceOptions asOptions()

  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.

• asFunction

   final ToolChoiceFunction asFunction()

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

• asMcp

   final ToolChoiceMcp asMcp()

  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(RealtimeResponseCreateParams.ToolChoice.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 = toolChoice.accept(new ToolChoice.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitOptions(ToolChoiceOptions options) {
          return Optional.of(options.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final RealtimeResponseCreateParams.ToolChoice 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()

• ofOptions

   final static RealtimeResponseCreateParams.ToolChoice ofOptions(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.

• ofFunction

   final static RealtimeResponseCreateParams.ToolChoice ofFunction(ToolChoiceFunction function)

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

• ofMcp

   final static RealtimeResponseCreateParams.ToolChoice ofMcp(ToolChoiceMcp mcp)

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