Package com.openai.models.responses
Class StructuredResponseTextConfig
-
- All Implemented Interfaces:
public final class StructuredResponseTextConfig<T extends Object>
A wrapper for ResponseTextConfig that provides a type-safe Builder that can record the responseType used to derive a JSON schema from an arbitrary class when using the Structured Outputs feature. When a JSON response is received, it is deserialized to an instance of that type. See the SDK documentation for more details on Structured Outputs.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
StructuredResponseTextConfig.Builder
A builder for StructuredResponseTextConfig.
-
Field Summary
Fields Modifier and Type Field Description private final Class<T>
responseType
private final ResponseTextConfig
rawConfig
-
Method Summary
Modifier and Type Method Description final Class<T>
responseType()
final ResponseTextConfig
rawConfig()
The raw, underlying response text configuration wrapped by this structured instance of the configuration. Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static <T extends Any> StructuredResponseTextConfig.Builder<T>
builder()
Returns a mutable builder for constructing an instance of StructuredResponseTextConfig. -
-
Method Detail
-
responseType
final Class<T> responseType()
-
rawConfig
final ResponseTextConfig rawConfig()
The raw, underlying response text configuration wrapped by this structured instance of the configuration.
-
builder
final static <T extends Any> StructuredResponseTextConfig.Builder<T> builder()
Returns a mutable builder for constructing an instance of StructuredResponseTextConfig.
-
-
-
-