REST Resource: projects.conversations.participants

Resource: Participant

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

JSON representation
{
  "name": string,
  "role": enum (Role),
  "sipRecordingMediaLabel": 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.

sipRecordingMediaLabel

string

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.

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" }.

Role

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

Enums
ROLE_UNSPECIFIED Participant role not set.
HUMAN_AGENT Participant is a human agent.
AUTOMATED_AGENT Participant is an automated agent, such as a Dialogflow agent.
END_USER Participant is an end user that has called or chatted with Dialogflow services.

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.