All Implemented Interfaces:
```
public final class AssistantResponseFormatOption

                    
```
Specifies the format that the model must output. Compatible with GPT-4o, [GPT-4
- Turbo](https://platform.openai.com/docs/models#gpt-4-turbo-and-gpt-4), and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.
Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.
Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.
Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`AssistantResponseFormatOption.Visitor`	An interface that defines how to map each variant of AssistantResponseFormatOption to a value of type T.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<JsonValue>`	`auto()`	`auto` is the default value
`final Optional<ResponseFormatText>`	`responseFormatText()`	Default response format.
`final Optional<ResponseFormatJsonObject>`	`responseFormatJsonObject()`	JSON object response format.
`final Optional<ResponseFormatJsonSchema>`	`responseFormatJsonSchema()`	JSON Schema response format.
`final Boolean`	`isAuto()`
`final Boolean`	`isResponseFormatText()`
`final Boolean`	`isResponseFormatJsonObject()`
`final Boolean`	`isResponseFormatJsonSchema()`
`final JsonValue`	`asAuto()`	`auto` is the default value
`final ResponseFormatText`	`asResponseFormatText()`	Default response format.
`final ResponseFormatJsonObject`	`asResponseFormatJsonObject()`	JSON object response format.
`final ResponseFormatJsonSchema`	`asResponseFormatJsonSchema()`	JSON Schema response format.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(AssistantResponseFormatOption.Visitor<T> visitor)`	Maps this instance's current variant to a value of type T using the given visitor.
`final AssistantResponseFormatOption`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static AssistantResponseFormatOption`	`ofAuto()`	`auto` is the default value
`final static AssistantResponseFormatOption`	`ofResponseFormatText(ResponseFormatText responseFormatText)`	Default response format.
`final static AssistantResponseFormatOption`	`ofResponseFormatJsonObject(ResponseFormatJsonObject responseFormatJsonObject)`	JSON object response format.
`final static AssistantResponseFormatOption`	`ofResponseFormatJsonSchema(ResponseFormatJsonSchema responseFormatJsonSchema)`	JSON Schema response format.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - auto
```
 final Optional<JsonValue> auto()
```
    auto is the default value
  - responseFormatText
```
 final Optional<ResponseFormatText> responseFormatText()
```
    Default response format. Used to generate text responses.
  - responseFormatJsonObject
```
 final Optional<ResponseFormatJsonObject> responseFormatJsonObject()
```
    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.
  - responseFormatJsonSchema
```
 final Optional<ResponseFormatJsonSchema> responseFormatJsonSchema()
```
    JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
  - isAuto
```
 final Boolean isAuto()
```
  - isResponseFormatText
```
 final Boolean isResponseFormatText()
```
  - isResponseFormatJsonObject
```
 final Boolean isResponseFormatJsonObject()
```
  - isResponseFormatJsonSchema
```
 final Boolean isResponseFormatJsonSchema()
```
  - asAuto
```
 final JsonValue asAuto()
```
    auto is the default value
  - asResponseFormatText
```
 final ResponseFormatText asResponseFormatText()
```
    Default response format. Used to generate text responses.
  - asResponseFormatJsonObject
```
 final ResponseFormatJsonObject asResponseFormatJsonObject()
```
    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.
  - asResponseFormatJsonSchema
```
 final ResponseFormatJsonSchema asResponseFormatJsonSchema()
```
    JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.
  - _json
```
 final Optional<JsonValue> _json()
```
  - accept
```
 final <T extends Any> T accept(AssistantResponseFormatOption.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 = assistantResponseFormatOption.accept(new AssistantResponseFormatOption.Visitor<Optional<String>>() { @Override public Optional<String> visitAuto(JsonValue auto) { return Optional.of(auto.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
  - validate
```
 final AssistantResponseFormatOption 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()
```
  - ofAuto
```
 final static AssistantResponseFormatOption ofAuto()
```
    auto is the default value
  - ofResponseFormatText
```
 final static AssistantResponseFormatOption ofResponseFormatText(ResponseFormatText responseFormatText)
```
    Default response format. Used to generate text responses.
  - ofResponseFormatJsonObject
```
 final static AssistantResponseFormatOption ofResponseFormatJsonObject(ResponseFormatJsonObject responseFormatJsonObject)
```
    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.
  - ofResponseFormatJsonSchema
```
 final static AssistantResponseFormatOption ofResponseFormatJsonSchema(ResponseFormatJsonSchema responseFormatJsonSchema)
```
    JSON Schema response format. Used to generate structured JSON responses. Learn more about Structured Outputs.

Class AssistantResponseFormatOption

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

auto

responseFormatText

responseFormatJsonObject

responseFormatJsonSchema

isAuto

isResponseFormatText

isResponseFormatJsonObject

isResponseFormatJsonSchema

asAuto

asResponseFormatText

asResponseFormatJsonObject

asResponseFormatJsonSchema

_json

accept

validate

isValid

equals

hashCode

toString

ofAuto

ofResponseFormatText

ofResponseFormatJsonObject

ofResponseFormatJsonSchema