Constructor Detail

Method Detail

• text

   final Optional<JsonValue> text()

  Unconstrained free-form text.

• grammar

   final Optional<ChatCompletionCustomTool.Custom.Format.Grammar> grammar()

  A grammar defined by the user.

• isText

   final Boolean isText()

• isGrammar

   final Boolean isGrammar()

• asText

   final JsonValue asText()

  Unconstrained free-form text.

• asGrammar

   final ChatCompletionCustomTool.Custom.Format.Grammar asGrammar()

  A grammar defined by the user.

• _json

   final Optional<JsonValue> _json()

• accept

   final <T extends Any> T accept(ChatCompletionCustomTool.Custom.Format.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 = format.accept(new Format.Visitor<Optional<String>>() {
      @Override
      public Optional<String> visitText(JsonValue text) {
          return Optional.of(text.toString());
      }
  
      // ...
  
      @Override
      public Optional<String> unknown(JsonValue json) {
          // Or inspect the `json`.
          return Optional.empty();
      }
  });

• validate

   final ChatCompletionCustomTool.Custom.Format 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()

• ofText

   final static ChatCompletionCustomTool.Custom.Format ofText()

  Unconstrained free-form text.

• ofGrammar

   final static ChatCompletionCustomTool.Custom.Format ofGrammar(ChatCompletionCustomTool.Custom.Format.Grammar grammar)

  A grammar defined by the user.