Class Participant (2.41.2)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
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_v2beta1.types.Participant.Role
Immutable. The role this participant plays in
the conversation. This field must be set during
participant creation and is then immutable.
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 uses this user id for billing and measurement. If
a user with the same obfuscated_external_user_id 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.="">
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
Enumeration of the roles a participant can play in a
conversation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Class Participant (2.41.2)\n\nVersion latestkeyboard_arrow_down\n\n- [2.41.2 (latest)](/python/docs/reference/dialogflow/latest/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.41.1](/python/docs/reference/dialogflow/2.41.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.40.0](/python/docs/reference/dialogflow/2.40.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.39.1](/python/docs/reference/dialogflow/2.39.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.38.0](/python/docs/reference/dialogflow/2.38.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.37.0](/python/docs/reference/dialogflow/2.37.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.36.0](/python/docs/reference/dialogflow/2.36.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.35.0](/python/docs/reference/dialogflow/2.35.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.34.0](/python/docs/reference/dialogflow/2.34.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.33.0](/python/docs/reference/dialogflow/2.33.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.32.0](/python/docs/reference/dialogflow/2.32.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.30.2](/python/docs/reference/dialogflow/2.30.2/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.29.0](/python/docs/reference/dialogflow/2.29.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.28.3](/python/docs/reference/dialogflow/2.28.3/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.27.0](/python/docs/reference/dialogflow/2.27.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.26.0](/python/docs/reference/dialogflow/2.26.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.25.0](/python/docs/reference/dialogflow/2.25.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.24.1](/python/docs/reference/dialogflow/2.24.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.23.3](/python/docs/reference/dialogflow/2.23.3/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.22.0](/python/docs/reference/dialogflow/2.22.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.21.0](/python/docs/reference/dialogflow/2.21.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.20.0](/python/docs/reference/dialogflow/2.20.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.19.1](/python/docs/reference/dialogflow/2.19.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.18.0](/python/docs/reference/dialogflow/2.18.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.17.0](/python/docs/reference/dialogflow/2.17.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.16.1](/python/docs/reference/dialogflow/2.16.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.15.2](/python/docs/reference/dialogflow/2.15.2/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.14.1](/python/docs/reference/dialogflow/2.14.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.13.0](/python/docs/reference/dialogflow/2.13.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.12.0](/python/docs/reference/dialogflow/2.12.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.11.0](/python/docs/reference/dialogflow/2.11.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.10.0](/python/docs/reference/dialogflow/2.10.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.9.1](/python/docs/reference/dialogflow/2.9.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.8.1](/python/docs/reference/dialogflow/2.8.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.7.1](/python/docs/reference/dialogflow/2.7.1/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.6.0](/python/docs/reference/dialogflow/2.6.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.5.0](/python/docs/reference/dialogflow/2.5.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.4.0](/python/docs/reference/dialogflow/2.4.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.3.0](/python/docs/reference/dialogflow/2.3.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.2.0](/python/docs/reference/dialogflow/2.2.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.1.2](/python/docs/reference/dialogflow/2.1.2/google.cloud.dialogflow_v2beta1.types.Participant)\n- [2.0.0](/python/docs/reference/dialogflow/2.0.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [1.1.3](/python/docs/reference/dialogflow/1.1.3/google.cloud.dialogflow_v2beta1.types.Participant)\n- [1.0.0](/python/docs/reference/dialogflow/1.0.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [0.8.0](/python/docs/reference/dialogflow/0.8.0/google.cloud.dialogflow_v2beta1.types.Participant)\n- [0.7.2](/python/docs/reference/dialogflow/0.7.2/google.cloud.dialogflow_v2beta1.types.Participant) \n\n Participant(mapping=None, *, ignore_unknown_fields=False, **kwargs)\n\nRepresents a conversation participant (human agent, virtual\nagent, end-user).\n\nClasses\n-------\n\n### DocumentsMetadataFiltersEntry\n\n DocumentsMetadataFiltersEntry(\n mapping=None, *, ignore_unknown_fields=False, **kwargs\n )\n\nThe abstract base class for a message.\n\n### Role\n\n Role(value)\n\nEnumeration of the roles a participant can play in a\nconversation."]]