Package com.sap.ai.sdk.foundationmodels.openai.generated.model

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 Classes

Modifier and Type	Class	Description
static enum	ChatCompletionRequestSystemMessage.RoleEnum	The role of the messages author, in this case `system`.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequestSystemMessage()

Method Summary

Modifier and Type	Method	Description
ChatCompletionRequestSystemMessage	content(ChatCompletionRequestSystemMessageContent content)	Set the content of this ChatCompletionRequestSystemMessage instance and return the same instance.
boolean	equals(Object o)
ChatCompletionRequestSystemMessageContent	getContent()	Get content
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionRequestSystemMessage.
String	getName()	An optional name for the participant.
ChatCompletionRequestSystemMessage.RoleEnum	getRole()	The role of the messages author, in this case `system`.
int	hashCode()
ChatCompletionRequestSystemMessage	name(String name)	Set the name of this ChatCompletionRequestSystemMessage instance and return the same instance.
ChatCompletionRequestSystemMessage	role(ChatCompletionRequestSystemMessage.RoleEnum role)	Set the role of this ChatCompletionRequestSystemMessage instance and return the same instance.
void	setContent(ChatCompletionRequestSystemMessageContent content)	Set the content of this ChatCompletionRequestSystemMessage instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionRequestSystemMessage instance.
void	setName(String name)	Set the name of this ChatCompletionRequestSystemMessage instance.
void	setRole(ChatCompletionRequestSystemMessage.RoleEnum role)	Set the role of this ChatCompletionRequestSystemMessage instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionRequestSystemMessage instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ChatCompletionRequestSystemMessage

public ChatCompletionRequestSystemMessage()

Method Details

content

@Nonnull
public ChatCompletionRequestSystemMessage content(@Nonnull
 ChatCompletionRequestSystemMessageContent content)

Set the content of this ChatCompletionRequestSystemMessage instance and return the same instance.

Parameters:

content - The content of this ChatCompletionRequestSystemMessage

Returns:

The same instance of this ChatCompletionRequestSystemMessage class

getContent

@Nonnull
public ChatCompletionRequestSystemMessageContent getContent()

Get content

Returns:

content The content of this ChatCompletionRequestSystemMessage instance.

setContent

public void setContent(@Nonnull
 ChatCompletionRequestSystemMessageContent content)

Set the content of this ChatCompletionRequestSystemMessage instance.

Parameters:

content - The content of this ChatCompletionRequestSystemMessage

role

@Nonnull
public ChatCompletionRequestSystemMessage role(@Nonnull
 ChatCompletionRequestSystemMessage.RoleEnum role)

Set the role of this ChatCompletionRequestSystemMessage instance and return the same instance.

Parameters:

role - The role of the messages author, in this case `system`.

Returns:

The same instance of this ChatCompletionRequestSystemMessage class

getRole

@Nonnull
public ChatCompletionRequestSystemMessage.RoleEnum getRole()

The role of the messages author, in this case `system`.

Returns:

role The role of this ChatCompletionRequestSystemMessage instance.

setRole

public void setRole(@Nonnull
 ChatCompletionRequestSystemMessage.RoleEnum role)

Set the role of this ChatCompletionRequestSystemMessage instance.

Parameters:

role - The role of the messages author, in this case `system`.

name

@Nonnull
public ChatCompletionRequestSystemMessage name(@Nullable
 String name)

Set the name of this ChatCompletionRequestSystemMessage instance 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 ChatCompletionRequestSystemMessage class

getName

@Nonnull
public String 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 ChatCompletionRequestSystemMessage instance.

setName

public void setName(@Nullable
 String name)

Set the name of this ChatCompletionRequestSystemMessage instance.

Parameters:

name - An optional name for the participant. Provides the model information to differentiate between participants of the same role.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionRequestSystemMessage.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this ChatCompletionRequestSystemMessage instance.

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

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this ChatCompletionRequestSystemMessage instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this ChatCompletionRequestSystemMessage instance. 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 property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object