Constructor Detail

Method Detail

• text

   final Optional<ResponseFormatText> text()

  Default response format. Used to generate text responses.

• jsonSchema

   final Optional<ResponseFormatJsonSchema> jsonSchema()

  JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

• jsonObject

   final Optional<ResponseFormatJsonObject> jsonObject()

  JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

• isText

   final Boolean isText()

• isJsonSchema

   final Boolean isJsonSchema()

• isJsonObject

   final Boolean isJsonObject()

• asText

   final ResponseFormatText asText()

  Default response format. Used to generate text responses.

• asJsonSchema

   final ResponseFormatJsonSchema asJsonSchema()

  JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

• asJsonObject

   final ResponseFormatJsonObject asJsonObject()

  JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.

• _json

   final Optional<JsonValue> _json()

• accept

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

• validate

   final ChatCompletionCreateParams.ResponseFormat 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 ChatCompletionCreateParams.ResponseFormat ofText(ResponseFormatText text)

  Default response format. Used to generate text responses.

• ofJsonSchema

   final static ChatCompletionCreateParams.ResponseFormat ofJsonSchema(ResponseFormatJsonSchema jsonSchema)

  JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

• ofJsonObject

   final static ChatCompletionCreateParams.ResponseFormat ofJsonObject(ResponseFormatJsonObject jsonObject)

  JSON object response format. An older method of generating JSON responses. Using json_schema is recommended for models that support it. Note that the model will not generate JSON without a system or user message instructing it to do so.