All Implemented Interfaces:
```
public final class ChatCompletionCreateParams.ResponseFormat

                    
```
An object specifying the format that the model must output.
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 the older JSON mode, which ensures the message the model generates is valid JSON. Using json_schema is preferred for models that support it.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ChatCompletionCreateParams.ResponseFormat.Visitor`	An interface that defines how to map each variant of ResponseFormat 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<ResponseFormatText>`	`text()`	Default response format.
`final Optional<ResponseFormatJsonSchema>`	`jsonSchema()`	JSON Schema response format.
`final Optional<ResponseFormatJsonObject>`	`jsonObject()`	JSON object response format.
`final Boolean`	`isText()`
`final Boolean`	`isJsonSchema()`
`final Boolean`	`isJsonObject()`
`final ResponseFormatText`	`asText()`	Default response format.
`final ResponseFormatJsonSchema`	`asJsonSchema()`	JSON Schema response format.
`final ResponseFormatJsonObject`	`asJsonObject()`	JSON object response format.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ChatCompletionCreateParams.ResponseFormat.Visitor<T> visitor)`
`final ChatCompletionCreateParams.ResponseFormat`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ChatCompletionCreateParams.ResponseFormat`	`ofText(ResponseFormatText text)`	Default response format.
`final static ChatCompletionCreateParams.ResponseFormat`	`ofJsonSchema(ResponseFormatJsonSchema jsonSchema)`	JSON Schema response format.
`final static ChatCompletionCreateParams.ResponseFormat`	`ofJsonObject(ResponseFormatJsonObject jsonObject)`	JSON object response format.

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

- 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)
```
  - validate
```
 final ChatCompletionCreateParams.ResponseFormat validate()
```
  - 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.

Class ChatCompletionCreateParams.ResponseFormat

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

text

jsonSchema

jsonObject

isText

isJsonSchema

isJsonObject

asText

asJsonSchema

asJsonObject

_json

accept

validate

isValid

equals

hashCode

toString

ofText

ofJsonSchema

ofJsonObject