Interface ParticipantOrBuilder (4.52.0)

public interface ParticipantOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDocumentsMetadataFilters(String key)

public abstract boolean containsDocumentsMetadataFilters(String key)

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 <code><code> documents_metadata_filters { key: "market" value: "US,CA" } documents_metadata_filters { key: "user" value: "agent" } </code></code>

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getDocumentsMetadataFilters() (deprecated)

public abstract Map<String,String> getDocumentsMetadataFilters()

Use #getDocumentsMetadataFiltersMap() instead.

Returns
Type	Description
`Map<String,String>`

getDocumentsMetadataFiltersCount()

public abstract int getDocumentsMetadataFiltersCount()

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`

getDocumentsMetadataFiltersMap()

public abstract Map<String,String> getDocumentsMetadataFiltersMap()

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Map<String,String>`

getDocumentsMetadataFiltersOrDefault(String key, String defaultValue)

public abstract String getDocumentsMetadataFiltersOrDefault(String key, String defaultValue)

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getDocumentsMetadataFiltersOrThrow(String key)

public abstract String getDocumentsMetadataFiltersOrThrow(String key)

map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String getName()

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

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

string name = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for name.

getObfuscatedExternalUserId()

public abstract String getObfuscatedExternalUserId()

Optional. Obfuscated user id that should be associated with the created participant.

You can specify a user id as follows:

If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant.
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.

string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The obfuscatedExternalUserId.

getObfuscatedExternalUserIdBytes()

public abstract ByteString getObfuscatedExternalUserIdBytes()

Optional. Obfuscated user id that should be associated with the created participant.

You can specify a user id as follows:

If you set this field in CreateParticipantRequest or UpdateParticipantRequest, Dialogflow adds the obfuscated user id with the participant.
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.

string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for obfuscatedExternalUserId.

getRole()

public abstract Participant.Role getRole()

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

.google.cloud.dialogflow.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`Participant.Role`	The role.

getRoleValue()

public abstract int getRoleValue()

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

.google.cloud.dialogflow.v2beta1.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`int`	The enum numeric value on the wire for role.