Class ResponseCompactParams.Body
-
- All Implemented Interfaces:
public final class ResponseCompactParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classResponseCompactParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseCompactParams.Model>model()Model ID used to generate the response, like gpt-5oro3.final Optional<ResponseCompactParams.Input>input()Text, image, or file inputs to the model, used to generate a response final Optional<String>instructions()A system (or developer) message inserted into the model's context. final Optional<String>previousResponseId()The unique ID of the previous response to the model. final JsonField<ResponseCompactParams.Model>_model()Returns the raw JSON value of model. final JsonField<ResponseCompactParams.Input>_input()Returns the raw JSON value of input. final JsonField<String>_instructions()Returns the raw JSON value of instructions. final JsonField<String>_previousResponseId()Returns the raw JSON value of previousResponseId. final Map<String, JsonValue>_additionalProperties()final ResponseCompactParams.Body.BuildertoBuilder()final ResponseCompactParams.Bodyvalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseCompactParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
model
final Optional<ResponseCompactParams.Model> model()
Model ID used to generate the response, like
gpt-5oro3. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.
-
input
final Optional<ResponseCompactParams.Input> input()
Text, image, or file inputs to the model, used to generate a response
-
instructions
final Optional<String> instructions()
A system (or developer) message inserted into the model's context. When used along with
previous_response_id, the instructions from a previous response will not be carried over to the next response. This makes it simple to swap out system (or developer) messages in new responses.
-
previousResponseId
final Optional<String> previousResponseId()
The unique ID of the previous response to the model. Use this to create multi-turn conversations. Learn more about conversation state. Cannot be used in conjunction with
conversation.
-
_model
final JsonField<ResponseCompactParams.Model> _model()
Returns the raw JSON value of model.
Unlike model, this method doesn't throw if the JSON field has an unexpected type.
-
_input
final JsonField<ResponseCompactParams.Input> _input()
Returns the raw JSON value of input.
Unlike input, this method doesn't throw if the JSON field has an unexpected type.
-
_instructions
final JsonField<String> _instructions()
Returns the raw JSON value of instructions.
Unlike instructions, this method doesn't throw if the JSON field has an unexpected type.
-
_previousResponseId
final JsonField<String> _previousResponseId()
Returns the raw JSON value of previousResponseId.
Unlike previousResponseId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ResponseCompactParams.Body.Builder toBuilder()
-
validate
final ResponseCompactParams.Body validate()
-
builder
final static ResponseCompactParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
The following fields are required:
.model()
-
-
-
-