CohereChatBotMessage¶

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

Bases: CohereMessage

A message that represents a single chat dialog as CHATBOT role.

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.
`message`	Gets the message of this CohereChatBotMessage.
`role`	[Required] Gets the role of this CohereMessage.
`tool_calls`	Gets the tool_calls of this CohereChatBotMessage.

Methods:

`__init__`(**kwargs)	Initializes a new CohereChatBotMessage 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 CohereChatBotMessage object with values from keyword arguments. The default value of the role attribute of this class is CHATBOT 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 CohereChatBotMessage. Allowed values for this property are: “CHATBOT”, “USER”, “SYSTEM”, “TOOL”
message (str) – The value to assign to the message property of this CohereChatBotMessage.
tool_calls (list[oci.generative_ai_inference.models.CohereToolCall]) – The value to assign to the tool_calls property of this CohereChatBotMessage.

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 message¶

Gets the message of this CohereChatBotMessage. Contents of the chat message.

Returns: The message of this CohereChatBotMessage.
Return type: str

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

property tool_calls¶

Gets the tool_calls of this CohereChatBotMessage. A list of tool calls generated by the model.

Returns: The tool_calls of this CohereChatBotMessage.
Return type: list[oci.generative_ai_inference.models.CohereToolCall]