Class ChatCompletionRequestSystemMessage
java.lang.Object
com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionRequestSystemMessage
- All Implemented Interfaces:
ChatCompletionRequestMessage
public class ChatCompletionRequestSystemMessage
extends Object
implements ChatCompletionRequestMessage
ChatCompletionRequestSystemMessage
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumThe role of the messages author, in this case `system`. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSet the content of thisChatCompletionRequestSystemMessageinstance and return the same instance.booleanGet contentgetCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theChatCompletionRequestSystemMessage.getName()An optional name for the participant.getRole()The role of the messages author, in this case `system`.inthashCode()Set the name of thisChatCompletionRequestSystemMessageinstance and return the same instance.Set the role of thisChatCompletionRequestSystemMessageinstance and return the same instance.voidSet the content of thisChatCompletionRequestSystemMessageinstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisChatCompletionRequestSystemMessageinstance.voidSet the name of thisChatCompletionRequestSystemMessageinstance.voidSet the role of thisChatCompletionRequestSystemMessageinstance.toMap()Get the value of all properties of thisChatCompletionRequestSystemMessageinstance including unrecognized properties.toString()
-
Constructor Details
-
ChatCompletionRequestSystemMessage
public ChatCompletionRequestSystemMessage()
-
-
Method Details
-
content
@Nonnull public ChatCompletionRequestSystemMessage content(@Nonnull ChatCompletionRequestSystemMessageContent content) Set the content of thisChatCompletionRequestSystemMessageinstance and return the same instance.- Parameters:
content- The content of thisChatCompletionRequestSystemMessage- Returns:
- The same instance of this
ChatCompletionRequestSystemMessageclass
-
getContent
Get content- Returns:
- content The content of this
ChatCompletionRequestSystemMessageinstance.
-
setContent
Set the content of thisChatCompletionRequestSystemMessageinstance.- Parameters:
content- The content of thisChatCompletionRequestSystemMessage
-
role
@Nonnull public ChatCompletionRequestSystemMessage role(@Nonnull ChatCompletionRequestSystemMessage.RoleEnum role) Set the role of thisChatCompletionRequestSystemMessageinstance and return the same instance.- Parameters:
role- The role of the messages author, in this case `system`.- Returns:
- The same instance of this
ChatCompletionRequestSystemMessageclass
-
getRole
The role of the messages author, in this case `system`.- Returns:
- role The role of this
ChatCompletionRequestSystemMessageinstance.
-
setRole
Set the role of thisChatCompletionRequestSystemMessageinstance.- Parameters:
role- The role of the messages author, in this case `system`.
-
name
Set the name of thisChatCompletionRequestSystemMessageinstance and return the same instance.- Parameters:
name- An optional name for the participant. Provides the model information to differentiate between participants of the same role.- Returns:
- The same instance of this
ChatCompletionRequestSystemMessageclass
-
getName
An optional name for the participant. Provides the model information to differentiate between participants of the same role.- Returns:
- name The name of this
ChatCompletionRequestSystemMessageinstance.
-
setName
Set the name of thisChatCompletionRequestSystemMessageinstance.- Parameters:
name- An optional name for the participant. Provides the model information to differentiate between participants of the same role.
-
getCustomFieldNames
Get the names of the unrecognizable properties of theChatCompletionRequestSystemMessage.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisChatCompletionRequestSystemMessageinstance.- Parameters:
name- The name of the property- Returns:
- The value of the property
- Throws:
NoSuchElementException- If no property with the given name could be found.
-
toMap
Get the value of all properties of thisChatCompletionRequestSystemMessageinstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisChatCompletionRequestSystemMessageinstance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.- Parameters:
customFieldName- The name of the propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
toMap()instead.