Package com.openai.models
Class ResponseFormatJsonObject
-
- All Implemented Interfaces:
public final class 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.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ResponseFormatJsonObject.Builder
A builder for ResponseFormatJsonObject.
-
Method Summary
Modifier and Type Method Description final JsonValue
_type()
The type of response format being defined. final Map<String, JsonValue>
_additionalProperties()
final ResponseFormatJsonObject.Builder
toBuilder()
final ResponseFormatJsonObject
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ResponseFormatJsonObject.Builder
builder()
Returns a mutable builder for constructing an instance of ResponseFormatJsonObject. -
-
Method Detail
-
_type
final JsonValue _type()
The type of response format being defined. Always
json_object
.Expected to always return the following:
JsonValue.from("json_object")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseFormatJsonObject.Builder toBuilder()
-
validate
final ResponseFormatJsonObject validate()
-
builder
final static ResponseFormatJsonObject.Builder builder()
Returns a mutable builder for constructing an instance of ResponseFormatJsonObject.
-
-
-
-