Class Participant (2.19.0)

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.