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

Class ChatCompletionRequestUserMessage

java.lang.Object

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

All Implemented Interfaces:

ChatCompletionRequestMessage

public class ChatCompletionRequestUserMessage
extends Object
implements ChatCompletionRequestMessage

ChatCompletionRequestUserMessage

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ChatCompletionRequestUserMessage()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionRequestUserMessage

public ChatCompletionRequestUserMessage()

Method Details

content

@Nonnull
public ChatCompletionRequestUserMessage content(@Nonnull
 ChatCompletionRequestUserMessageContent content)

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

Parameters:

content - The content of this ChatCompletionRequestUserMessage

Returns:

The same instance of this ChatCompletionRequestUserMessage class

getContent

@Nonnull
public ChatCompletionRequestUserMessageContent getContent()

Get content

Returns:

content The content of this ChatCompletionRequestUserMessage instance.

setContent

public void setContent(@Nonnull
 ChatCompletionRequestUserMessageContent content)

Set the content of this ChatCompletionRequestUserMessage instance.

Parameters:

content - The content of this ChatCompletionRequestUserMessage

role

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

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

Parameters:

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

Returns:

The same instance of this ChatCompletionRequestUserMessage class

getRole

@Nonnull
public ChatCompletionRequestUserMessage.RoleEnum getRole()

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

Returns:

role The role of this ChatCompletionRequestUserMessage instance.

setRole

public void setRole(@Nonnull
 ChatCompletionRequestUserMessage.RoleEnum role)

Set the role of this ChatCompletionRequestUserMessage instance.

Parameters:

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

name

@Nonnull
public ChatCompletionRequestUserMessage name(@Nullable
 String name)

Set the name of this ChatCompletionRequestUserMessage 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 ChatCompletionRequestUserMessage 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 ChatCompletionRequestUserMessage instance.

setName

public void setName(@Nullable
 String name)

Set the name of this ChatCompletionRequestUserMessage 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 ChatCompletionRequestUserMessage.

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 ChatCompletionRequestUserMessage 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 ChatCompletionRequestUserMessage 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 ChatCompletionRequestUserMessage 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