Class ChatCompletionUserMessageParam.Content
-
- All Implemented Interfaces:
public final class ChatCompletionUserMessageParam.ContentThe contents of the user message.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceChatCompletionUserMessageParam.Content.VisitorAn interface that defines how to map each variant of Content to a value of type T.
-
Method Summary
Modifier and Type Method Description final Optional<String>text()The text contents of the message. final Optional<List<ChatCompletionContentPart>>arrayOfContentParts()An array of content parts with a defined type. final BooleanisText()final BooleanisArrayOfContentParts()final StringasText()The text contents of the message. final List<ChatCompletionContentPart>asArrayOfContentParts()An array of content parts with a defined type. final Optional<JsonValue>_json()final <T extends Any> Taccept(ChatCompletionUserMessageParam.Content.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ChatCompletionUserMessageParam.Contentvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static ChatCompletionUserMessageParam.ContentofText(String text)The text contents of the message. final static ChatCompletionUserMessageParam.ContentofArrayOfContentParts(List<ChatCompletionContentPart> arrayOfContentParts)An array of content parts with a defined type. -
-
Method Detail
-
arrayOfContentParts
final Optional<List<ChatCompletionContentPart>> arrayOfContentParts()
An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs.
-
isArrayOfContentParts
final Boolean isArrayOfContentParts()
-
asArrayOfContentParts
final List<ChatCompletionContentPart> asArrayOfContentParts()
An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs.
-
accept
final <T extends Any> T accept(ChatCompletionUserMessageParam.Content.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 = content.accept(new Content.Visitor<Optional<String>>() { @Override public Optional<String> visitText(String text) { return Optional.of(text.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
-
validate
final ChatCompletionUserMessageParam.Content 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.
-
ofText
final static ChatCompletionUserMessageParam.Content ofText(String text)
The text contents of the message.
-
ofArrayOfContentParts
final static ChatCompletionUserMessageParam.Content ofArrayOfContentParts(List<ChatCompletionContentPart> arrayOfContentParts)
An array of content parts with a defined type. Supported options differ based on the model being used to generate the response. Can contain text, image, or audio inputs.
-
-
-
-