AssistantMessage¶
-
class
oci.generative_ai_inference.models.
AssistantMessage
(**kwargs)¶ Bases:
oci.generative_ai_inference.models.message.Message
Represents a single instance of assistant message.
Attributes
ROLE_ASSISTANT
str(object=’’) -> str ROLE_SYSTEM
str(object=’’) -> str ROLE_USER
str(object=’’) -> str content
Gets the content of this Message. name
Gets the name of this AssistantMessage. role
[Required] Gets the role of this Message. Methods
__init__
(**kwargs)Initializes a new AssistantMessage 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'¶
-
ROLE_SYSTEM
= 'SYSTEM'¶
-
ROLE_USER
= 'USER'¶
-
__init__
(**kwargs)¶ Initializes a new AssistantMessage object with values from keyword arguments. The default value of the
role
attribute of this class isASSISTANT
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 AssistantMessage. Allowed values for this property are: “SYSTEM”, “USER”, “ASSISTANT”
- content (list[oci.generative_ai_inference.models.ChatContent]) – The value to assign to the content property of this AssistantMessage.
- name (str) – The value to assign to the name property of this AssistantMessage.
-
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.
-
name
¶ Gets the name of this AssistantMessage. An optional name for the participant. Provides the model information to differentiate between participants of the same role.
Returns: The name of this AssistantMessage. Return type: str
-
role
¶ [Required] Gets the role of this Message. Indicates who is writing the current chat message.
Allowed values for this property are: “SYSTEM”, “USER”, “ASSISTANT”, ‘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
-