Class ChatCompletionSystemMessageParam
-
- All Implemented Interfaces:
public final class ChatCompletionSystemMessageParam
Developer-provided instructions that the model should follow, regardless of messages sent by the user. With o1 models and newer, use
developer
messages for this purpose instead.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
ChatCompletionSystemMessageParam.Builder
A builder for ChatCompletionSystemMessageParam.
public final class
ChatCompletionSystemMessageParam.Content
The contents of the system message.
-
Method Summary
Modifier and Type Method Description final ChatCompletionSystemMessageParam.Content
content()
The contents of the system message. final JsonValue
_role()
The role of the messages author, in this case system
.final Optional<String>
name()
An optional name for the participant. final JsonField<ChatCompletionSystemMessageParam.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 ChatCompletionSystemMessageParam.Builder
toBuilder()
final ChatCompletionSystemMessageParam
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static ChatCompletionSystemMessageParam.Builder
builder()
Returns a mutable builder for constructing an instance of ChatCompletionSystemMessageParam. -
-
Method Detail
-
content
final ChatCompletionSystemMessageParam.Content content()
The contents of the system message.
-
_role
final JsonValue _role()
The role of the messages author, in this case
system
.Expected to always return the following:
JsonValue.from("system")
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<ChatCompletionSystemMessageParam.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 ChatCompletionSystemMessageParam.Builder toBuilder()
-
validate
final ChatCompletionSystemMessageParam validate()
-
builder
final static ChatCompletionSystemMessageParam.Builder builder()
Returns a mutable builder for constructing an instance of ChatCompletionSystemMessageParam.
The following fields are required:
.content()
-
-
-
-