Class ChatCompletionToolMessageParam.Content
-
- All Implemented Interfaces:
public final class ChatCompletionToolMessageParam.ContentThe contents of the tool message.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public interfaceChatCompletionToolMessageParam.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 contents of the tool message. final Optional<List<ChatCompletionContentPartText>>arrayOfContentParts()An array of content parts with a defined type. final BooleanisText()final BooleanisArrayOfContentParts()final StringasText()The contents of the tool message. final List<ChatCompletionContentPartText>asArrayOfContentParts()An array of content parts with a defined type. final Optional<JsonValue>_json()final <T extends Any> Taccept(ChatCompletionToolMessageParam.Content.Visitor<T> visitor)Maps this instance's current variant to a value of type T using the given visitor. final ChatCompletionToolMessageParam.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 ChatCompletionToolMessageParam.ContentofText(String text)The contents of the tool message. final static ChatCompletionToolMessageParam.ContentofArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)An array of content parts with a defined type. -
-
Method Detail
-
arrayOfContentParts
final Optional<List<ChatCompletionContentPartText>> arrayOfContentParts()
An array of content parts with a defined type. For tool messages, only type
textis supported.
-
isArrayOfContentParts
final Boolean isArrayOfContentParts()
-
asArrayOfContentParts
final List<ChatCompletionContentPartText> asArrayOfContentParts()
An array of content parts with a defined type. For tool messages, only type
textis supported.
-
accept
final <T extends Any> T accept(ChatCompletionToolMessageParam.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 ChatCompletionToolMessageParam.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 ChatCompletionToolMessageParam.Content ofText(String text)
The contents of the tool message.
-
ofArrayOfContentParts
final static ChatCompletionToolMessageParam.Content ofArrayOfContentParts(List<ChatCompletionContentPartText> arrayOfContentParts)
An array of content parts with a defined type. For tool messages, only type
textis supported.
-
-
-
-