REST Resource: projects.locations.conversations.participants

Resource: Participant

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

JSON representation 
{
  "name": string,
  "role": enum (Role),
  "obfuscatedExternalUserId": string,
  "documentsMetadataFilters": {
    string: string,
    ...
  }
}
Fields
name

string

Optional. The unique identifier of this participant. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.
role

enum (Role)

Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
obfuscatedExternalUserId

string

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 participants.analyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.obfuscated_external_user_id.

Dialogflow uses this user id for billing and measurement. If a user with the same obfuscatedExternalUserId is created in a later conversation, Dialogflow will know it's the same user.

Dialogflow also uses this user id for Agent Assist suggestion personalization. For example, Dialogflow can use it to provide personalized smart reply suggestions for this user.

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.
documentsMetadataFilters

map (key: string, value: string)

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

documentsMetadataFilters {
  key: "market"
  value: "US,CA"
}
documentsMetadataFilters {
  key: "user"
  value: "agent"
}

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

analyzeContent

 Adds a text (chat, for example), or audio (phone recording, for example) message from a participant into the conversation.

create

 Creates a new participant in a conversation.

get

 Retrieves a conversation participant.

list

 Returns the list of all participants in the specified conversation.

patch

 Updates the specified participant.