Constructor Detail

Method Detail

• function

   final Optional<ChatCompletionFunctionTool> function()

  A function tool that can be used to generate a response.

• custom

   final Optional<ChatCompletionCustomTool> custom()

  A custom tool that processes input using a specified format.

• isFunction

   final Boolean isFunction()

• isCustom

   final Boolean isCustom()

• asFunction

   final ChatCompletionFunctionTool asFunction()

  A function tool that can be used to generate a response.

• asCustom

   final ChatCompletionCustomTool asCustom()

  A custom tool that processes input using a specified format.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ChatCompletionTool.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 = chatCompletionTool.accept(new ChatCompletionTool.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitFunction(ChatCompletionFunctionTool function) {
          return Optional.of(function.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

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

• ofFunction

   final static ChatCompletionTool ofFunction(ChatCompletionFunctionTool function)

  A function tool that can be used to generate a response.

• ofCustom

   final static ChatCompletionTool ofCustom(ChatCompletionCustomTool custom)

  A custom tool that processes input using a specified format.