UserMessage¶

class oci.generative_ai_inference.models.UserMessage(**kwargs)¶

Bases: Message

Represents a single instance of user message.

Attributes:

`ROLE_ASSISTANT`	A constant which can be used with the role property of a Message.
`ROLE_DEVELOPER`	A constant which can be used with the role property of a Message.
`ROLE_SYSTEM`	A constant which can be used with the role property of a Message.
`ROLE_TOOL`	A constant which can be used with the role property of a Message.
`ROLE_USER`	A constant which can be used with the role property of a Message.
`content`	Gets the content of this Message.
`name`	Gets the name of this UserMessage.
`role`	[Required] Gets the role of this Message.

Methods:

`__init__`(**kwargs)	Initializes a new UserMessage object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

ROLE_ASSISTANT = 'ASSISTANT'¶: A constant which can be used with the role property of a Message. This constant has a value of “ASSISTANT”

ROLE_DEVELOPER = 'DEVELOPER'¶: A constant which can be used with the role property of a Message. This constant has a value of “DEVELOPER”

ROLE_SYSTEM = 'SYSTEM'¶: A constant which can be used with the role property of a Message. This constant has a value of “SYSTEM”

ROLE_TOOL = 'TOOL'¶: A constant which can be used with the role property of a Message. This constant has a value of “TOOL”

ROLE_USER = 'USER'¶: A constant which can be used with the role property of a Message. This constant has a value of “USER”

__init__(**kwargs)¶

Initializes a new UserMessage object with values from keyword arguments. The default value of the role attribute of this class is USER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

role (str) – The value to assign to the role property of this UserMessage. Allowed values for this property are: “SYSTEM”, “ASSISTANT”, “USER”, “TOOL”, “DEVELOPER”
content (list[oci.generative_ai_inference.models.ChatContent]) – The value to assign to the content property of this UserMessage.
name (str) – The value to assign to the name property of this UserMessage.

property content¶

Gets the content of this Message. Contents of the chat message.

Returns: The content of this Message.
Return type: list[oci.generative_ai_inference.models.ChatContent]

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property name¶

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

Returns: The name of this UserMessage.
Return type: str

property role¶

[Required] Gets the role of this Message. Indicates who is writing the current chat message.

Allowed values for this property are: “SYSTEM”, “ASSISTANT”, “USER”, “TOOL”, “DEVELOPER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The role of this Message.
Return type: str