Participant
Represents a single side of the conversation.
Props
documents_metadata_filters
documents_metadata_filters: {[key: string]: string}
| undefined
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 a 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 are documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }.
name
name: string
| undefined
Optional. The unique identifier of this participant. Format: projects/<Project ID>/conversations/<Conversation ID>/participants/<Participant ID>
.
obfuscated_external_user_id
obfuscated_external_user_id: string
| undefined
Optional. Obfuscated user id that should be associated with the created participant. You can specify a user id as follows:
- If you set this field in
CreateParticipantRequest
orUpdateParticipantRequest
, Dialogflow adds the obfuscated user id with the participant. - If you set this field in
AnalyzeContent
orStreamingAnalyzeContent
, Dialogflow updatesParticipant.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: - 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.
role
role:
Immutable. The role this participant plays in the conversation. This field can only be set during creation.
sip_recording_media_label
sip_recording_media_label: string
| undefined
Optional. Label applied to streams representing this participant in SIPREC XML metadata and SDP. Use it to assign transcriptions from that media stream to this participant. This field can be updated.