Class ChatCompletionUserMessageParam
-
- All Implemented Interfaces:
public final class ChatCompletionUserMessageParamMessages sent by an end user, containing prompts or additional context information.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classChatCompletionUserMessageParam.BuilderA builder for ChatCompletionUserMessageParam.
public final classChatCompletionUserMessageParam.ContentThe contents of the user message.
-
Method Summary
Modifier and Type Method Description final ChatCompletionUserMessageParam.Contentcontent()The contents of the user message. final JsonValue_role()The role of the messages author, in this case user.final Optional<String>name()An optional name for the participant. final JsonField<ChatCompletionUserMessageParam.Content>_content()Returns the raw JSON value of content. final JsonField<String>_name()Returns the raw JSON value of name. final Map<String, JsonValue>_additionalProperties()final ChatCompletionUserMessageParam.BuildertoBuilder()final ChatCompletionUserMessageParamvalidate()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.Builderbuilder()Returns a mutable builder for constructing an instance of ChatCompletionUserMessageParam. -
-
Method Detail
-
content
final ChatCompletionUserMessageParam.Content content()
The contents of the user message.
-
_role
final JsonValue _role()
The role of the messages author, in this case
user.Expected to always return the following:
JsonValue.from("user")However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
name
final Optional<String> name()
An optional name for the participant. Provides the model information to differentiate between participants of the same role.
-
_content
final JsonField<ChatCompletionUserMessageParam.Content> _content()
Returns the raw JSON value of content.
Unlike content, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final ChatCompletionUserMessageParam.Builder toBuilder()
-
validate
final ChatCompletionUserMessageParam 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 ChatCompletionUserMessageParam.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionUserMessageParam.
The following fields are required:
.content()
-
-
-
-