ParticipantArgs class

The set of arguments for Participant. The set of arguments for Participant.

Constructors

ParticipantArgs({required Input<String> conversationId, Input<Map<String, String>>? documentsMetadataFilters, Input<String>? location, Input<String>? name, Input<String>? obfuscatedExternalUserId, Input<String>? project, Input<ParticipantRole>? role, Input<String>? sipRecordingMediaLabel})
Creates a new ParticipantArgs. conversationId Required. documentsMetadataFilters 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" } location Optional. name Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/. 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 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: * 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. project Optional. role Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable. sipRecordingMediaLabel 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.
const
ParticipantArgs.fromMap(Map<String, dynamic> map)
factory

Properties

conversationId → Input<String>
final
documentsMetadataFilters → Input<Map<String, 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 documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" }
final
hashCode → int
The hash code for this object.
no setterinherited
location → Input<String>?
final
name → Input<String>?
Optional. The unique identifier of this participant. Format: projects//locations//conversations//participants/.
final
obfuscatedExternalUserId → Input<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 AnalyzeContent or StreamingAnalyzeContent, Dialogflow will update Participant.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: * 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.
final
project → Input<String>?
final
role → Input<ParticipantRole>?
Immutable. The role this participant plays in the conversation. This field must be set during participant creation and is then immutable.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sipRecordingMediaLabel → Input<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.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited