Class ChatCompletionToolMessageParam
-
- All Implemented Interfaces:
public final class ChatCompletionToolMessageParam
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionToolMessageParam.BuilderA builder for ChatCompletionToolMessageParam.
public final classChatCompletionToolMessageParam.ContentThe contents of the tool message.
-
Method Summary
Modifier and Type Method Description final ChatCompletionToolMessageParam.Contentcontent()The contents of the tool message. final JsonValue_role()The role of the messages author, in this case tool.final StringtoolCallId()Tool call that this message is responding to. final JsonField<ChatCompletionToolMessageParam.Content>_content()Returns the raw JSON value of content. final JsonField<String>_toolCallId()Returns the raw JSON value of toolCallId. final Map<String, JsonValue>_additionalProperties()final ChatCompletionToolMessageParam.BuildertoBuilder()final ChatCompletionToolMessageParamvalidate()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.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionToolMessageParam. -
-
Method Detail
-
content
final ChatCompletionToolMessageParam.Content content()
The contents of the tool message.
-
_role
final JsonValue _role()
The role of the messages author, in this case
tool.Expected to always return the following:
JsonValue.from("tool")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
toolCallId
final String toolCallId()
Tool call that this message is responding to.
-
_content
final JsonField<ChatCompletionToolMessageParam.Content> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_toolCallId
final JsonField<String> _toolCallId()
Returns the raw JSON value of toolCallId.
Unlike toolCallId, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionToolMessageParam.Builder toBuilder()
-
validate
final ChatCompletionToolMessageParam 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.
-
builder
final static ChatCompletionToolMessageParam.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionToolMessageParam.
The following fields are required:
.content() .toolCallId()
-
-
-
-