CohereMessage

class oci.generative_ai_inference.models.CohereMessage(**kwargs)

Bases: object

A message that represents a single chat dialog.

Attributes:

ROLE_CHATBOT	A constant which can be used with the role property of a CohereMessage.
ROLE_SYSTEM	A constant which can be used with the role property of a CohereMessage.
ROLE_TOOL	A constant which can be used with the role property of a CohereMessage.
ROLE_USER	A constant which can be used with the role property of a CohereMessage.
role	[Required] Gets the role of this CohereMessage.

Methods:

__init__(**kwargs)	Initializes a new CohereMessage 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_CHATBOT = 'CHATBOT'

A constant which can be used with the role property of a CohereMessage. This constant has a value of “CHATBOT”

ROLE_SYSTEM = 'SYSTEM'

A constant which can be used with the role property of a CohereMessage. This constant has a value of “SYSTEM”

ROLE_TOOL = 'TOOL'

A constant which can be used with the role property of a CohereMessage. This constant has a value of “TOOL”

ROLE_USER = 'USER'

A constant which can be used with the role property of a CohereMessage. This constant has a value of “USER”

__init__(**kwargs)

Initializes a new CohereMessage object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

• CohereChatBotMessage

• CohereSystemMessage

• CohereToolMessage

• CohereUserMessage

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 CohereMessage. Allowed values for this property are: “CHATBOT”, “USER”, “SYSTEM”, “TOOL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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 role

[Required] Gets the role of this CohereMessage. To identify who the message is coming from, a role is associated to each message.

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

Returns

The role of this CohereMessage.

Return type

str