GetParticipantResult

data class GetParticipantResult(val documentsMetadataFilters: Map<String, String>, val name: String, val obfuscatedExternalUserId: String, val role: String)

Constructors

Link copied to clipboard
fun GetParticipantResult(documentsMetadataFilters: Map<String, String>, name: String, obfuscatedExternalUserId: String, role: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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" } `` @property name Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/. @property obfuscatedExternalUserId 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 uses this user id for following purposes: 1) Billing and measurement. If user with the same obfuscated_external_user_id is created in a later conversation, dialogflow will know it's the same user. 2) 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. @property role Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.

Link copied to clipboard
Link copied to clipboard