public static final class Participant.Builder extends GeneratedMessageV3.Builder<Participant.Builder> implements ParticipantOrBuilder
Represents a conversation participant (human agent, virtual agent, end-user).
Protobuf type google.cloud.dialogflow.v2beta1.Participant
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Participant.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
public Participant build()
Returns
buildPartial()
public Participant buildPartial()
Returns
clear()
public Participant.Builder clear()
Returns
Overrides
public Participant.Builder clearDocumentsMetadataFilters()
Returns
clearField(Descriptors.FieldDescriptor field)
public Participant.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearName()
public Participant.Builder clearName()
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];
clearObfuscatedExternalUserId()
public Participant.Builder clearObfuscatedExternalUserId()
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 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.
string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
clearOneof(Descriptors.OneofDescriptor oneof)
public Participant.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
clearRole()
public Participant.Builder clearRole()
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];
clone()
public Participant.Builder clone()
Returns
Overrides
public 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];
getDefaultInstanceForType()
public Participant getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
public Map<String,String> getDocumentsMetadataFilters()
Returns
public int getDocumentsMetadataFiltersCount()
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];
public Map<String,String> getDocumentsMetadataFiltersMap()
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];
public String getDocumentsMetadataFiltersOrDefault(String key, String defaultValue)
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];
public String getDocumentsMetadataFiltersOrThrow(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];
public Map<String,String> getMutableDocumentsMetadataFilters()
Use alternate mutation accessors instead.
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];
| Type | Description |
| String | The name.
|
getNameBytes()
public 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];
getObfuscatedExternalUserId()
public 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 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.
string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| String | The obfuscatedExternalUserId.
|
getObfuscatedExternalUserIdBytes()
public 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 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.
string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Type | Description |
| ByteString | The bytes for obfuscatedExternalUserId.
|
getRole()
public 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];
getRoleValue()
public 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];
| Type | Description |
| int | The enum numeric value on the wire for role.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Participant other)
public Participant.Builder mergeFrom(Participant other)
Parameter
Returns
public Participant.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Participant.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Participant.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
public Participant.Builder putAllDocumentsMetadataFilters(Map<String,String> values)
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];
public Participant.Builder putDocumentsMetadataFilters(String key, String value)
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];
public Participant.Builder removeDocumentsMetadataFilters(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];
setField(Descriptors.FieldDescriptor field, Object value)
public Participant.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setName(String value)
public Participant.Builder setName(String value)
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];
| Name | Description |
| value | String
The name to set.
|
Returns
setNameBytes(ByteString value)
public Participant.Builder setNameBytes(ByteString value)
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];
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setObfuscatedExternalUserId(String value)
public Participant.Builder setObfuscatedExternalUserId(String value)
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 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.
string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | String
The obfuscatedExternalUserId to set.
|
Returns
setObfuscatedExternalUserIdBytes(ByteString value)
public Participant.Builder setObfuscatedExternalUserIdBytes(ByteString value)
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 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.
string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
| Name | Description |
| value | ByteString
The bytes for obfuscatedExternalUserId to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Participant.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setRole(Participant.Role value)
public Participant.Builder setRole(Participant.Role value)
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];
setRoleValue(int value)
public Participant.Builder setRoleValue(int value)
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];
| Name | Description |
| value | int
The enum numeric value on the wire for role to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final Participant.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
