Class ResponseContent
-
- All Implemented Interfaces:
public final class ResponseContentMulti-modal input and output contents.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceResponseContent.VisitorAn interface that defines how to map each variant of ResponseContent to a value of type T.
public final classResponseContent.ReasoningTextContentReasoning text from the model.
-
Method Summary
Modifier and Type Method Description final Optional<ResponseInputText>inputText()A text input to the model. final Optional<ResponseInputImage>inputImage()An image input to the model. final Optional<ResponseInputFile>inputFile()A file input to the model. final Optional<ResponseOutputText>outputText()A text output from the model. final Optional<ResponseOutputRefusal>outputRefusal()A refusal from the model. final Optional<ResponseContent.ReasoningTextContent>reasoningText()Reasoning text from the model. final BooleanisInputText()final BooleanisInputImage()final BooleanisInputFile()final BooleanisOutputText()final BooleanisOutputRefusal()final BooleanisReasoningText()final ResponseInputTextasInputText()A text input to the model. final ResponseInputImageasInputImage()An image input to the model. final ResponseInputFileasInputFile()A file input to the model. final ResponseOutputTextasOutputText()A text output from the model. final ResponseOutputRefusalasOutputRefusal()A refusal from the model. final ResponseContent.ReasoningTextContentasReasoningText()Reasoning text from the model. final Optional<JsonValue>_json()final <T extends Any> Taccept(ResponseContent.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ResponseContentvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ResponseContentofInputText(ResponseInputText inputText)A text input to the model. final static ResponseContentofInputImage(ResponseInputImage inputImage)An image input to the model. final static ResponseContentofInputFile(ResponseInputFile inputFile)A file input to the model. final static ResponseContentofOutputText(ResponseOutputText outputText)A text output from the model. final static ResponseContentofOutputRefusal(ResponseOutputRefusal outputRefusal)A refusal from the model. final static ResponseContentofReasoningText(ResponseContent.ReasoningTextContent reasoningText)Reasoning text from the model. -
-
Method Detail
-
inputText
final Optional<ResponseInputText> inputText()
A text input to the model.
-
inputImage
final Optional<ResponseInputImage> inputImage()
An image input to the model. Learn about image inputs.
-
inputFile
final Optional<ResponseInputFile> inputFile()
A file input to the model.
-
outputText
final Optional<ResponseOutputText> outputText()
A text output from the model.
-
outputRefusal
final Optional<ResponseOutputRefusal> outputRefusal()
A refusal from the model.
-
reasoningText
final Optional<ResponseContent.ReasoningTextContent> reasoningText()
Reasoning text from the model.
-
isInputText
final Boolean isInputText()
-
isInputImage
final Boolean isInputImage()
-
isInputFile
final Boolean isInputFile()
-
isOutputText
final Boolean isOutputText()
-
isOutputRefusal
final Boolean isOutputRefusal()
-
isReasoningText
final Boolean isReasoningText()
-
asInputText
final ResponseInputText asInputText()
A text input to the model.
-
asInputImage
final ResponseInputImage asInputImage()
An image input to the model. Learn about image inputs.
-
asInputFile
final ResponseInputFile asInputFile()
A file input to the model.
-
asOutputText
final ResponseOutputText asOutputText()
A text output from the model.
-
asOutputRefusal
final ResponseOutputRefusal asOutputRefusal()
A refusal from the model.
-
asReasoningText
final ResponseContent.ReasoningTextContent asReasoningText()
Reasoning text from the model.
-
accept
final <T extends Any> T accept(ResponseContent.Visitor<T> visitor)
Maps this instance's current variant to a value of type T using the given visitor.
Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = responseContent.accept(new ResponseContent.Visitor<Optional<String>>() { @Override public Optional<String> visitInputText(ResponseInputText inputText) { return Optional.of(inputText.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final ResponseContent validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
ofInputText
final static ResponseContent ofInputText(ResponseInputText inputText)
A text input to the model.
-
ofInputImage
final static ResponseContent ofInputImage(ResponseInputImage inputImage)
An image input to the model. Learn about image inputs.
-
ofInputFile
final static ResponseContent ofInputFile(ResponseInputFile inputFile)
A file input to the model.
-
ofOutputText
final static ResponseContent ofOutputText(ResponseOutputText outputText)
A text output from the model.
-
ofOutputRefusal
final static ResponseContent ofOutputRefusal(ResponseOutputRefusal outputRefusal)
A refusal from the model.
-
ofReasoningText
final static ResponseContent ofReasoningText(ResponseContent.ReasoningTextContent reasoningText)
Reasoning text from the model.
-
-
-
-