Class Participant (2.30.0)

Version latest

• 2.30.0 (latest)
• 2.29.0
• 2.28.3
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.1
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.1
• 2.18.0
• 2.17.0
• 2.16.1
• 2.15.2
• 2.14.1
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.1
• 2.8.1
• 2.7.1
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.2
• 2.0.0
• 1.1.3
• 1.0.0
• 0.8.0
• 0.7.2

Participant(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents a conversation participant (human agent, virtual agent, end-user).

Attributes
Name	Description
name	str Optional. The unique identifier of this participant. Format: projects/.
role	google.cloud.dialogflow_v2.types.Participant.Role Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
sip_recording_media_label	str Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. This is used to assign transcriptions from that media stream to this participant. This field can be updated.
obfuscated_external_user_id	str Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows: 1. If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant. 2. If you set this field in AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id. Dialogflow returns an error if you try to add a user id for a non-END_USER participant. Dialogflow uses this user id for billing and measurement purposes. For example, Dialogflow determines whether a user in one conversation returned in a later conversation. Note: - Please never pass raw user ids to Dialogflow. Always obfuscate your user id first. - Dialogflow only accepts a UTF-8 encoded string, e.g., a hex digest of a hash function like SHA-512. - The length of the user id must be <= 256="" characters.="">
documents_metadata_filters	MutableMapping[str, str] Optional. Key-value filters on the metadata of documents returned by article suggestion. If specified, article suggestion only returns suggested documents that match all filters in their Document.metadata. Multiple values for a metadata key should be concatenated by comma. For example, filters to match all documents that have 'US' or 'CA' in their market metadata values and 'agent' in their user metadata values will be :: documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }

Classes

DocumentsMetadataFiltersEntry

DocumentsMetadataFiltersEntry(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

Role

Role(value)

Enumeration of the roles a participant can play in a conversation.

Values: ROLE_UNSPECIFIED (0): Participant role not set. HUMAN_AGENT (1): Participant is a human agent. AUTOMATED_AGENT (2): Participant is an automated agent, such as a Dialogflow agent. END_USER (3): Participant is an end user that has called or chatted with Dialogflow services.