Package com.openai.models.responses
Class StructuredResponseCreateParams
-
- All Implemented Interfaces:
public final class StructuredResponseCreateParams<T extends Object>A wrapper for ResponseCreateParams 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 am 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 classStructuredResponseCreateParams.Builder
-
Field Summary
Fields Modifier and Type Field Description private final Class<T>responseTypeprivate final ResponseCreateParamsrawParams
-
Constructor Summary
Constructors Constructor Description StructuredResponseCreateParams(Class<T> responseType, ResponseCreateParams rawParams)
-
Method Summary
Modifier and Type Method Description final Class<T>responseType()final ResponseCreateParamsrawParams()The raw, underlying response create parameters wrapped by this structured instance of the parameters. Booleanequals(Object other)IntegerhashCode()StringtoString()final static <T extends Any> StructuredResponseCreateParams.Builder<T>builder()-
-
Constructor Detail
-
StructuredResponseCreateParams
StructuredResponseCreateParams(Class<T> responseType, ResponseCreateParams rawParams)
-
-
Method Detail
-
responseType
final Class<T> responseType()
-
rawParams
final ResponseCreateParams rawParams()
The raw, underlying response create parameters wrapped by this structured instance of the parameters.
-
builder
final static <T extends Any> StructuredResponseCreateParams.Builder<T> builder()
-
-
-
-