public final class Participant extends GeneratedMessageV3 implements ParticipantOrBuilder
Represents a conversation participant (human agent, virtual agent, end-user).
Protobuf type google.cloud.dialogflow.v2beta1.Participant
Fields
public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
Field Value
ROLE_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
Field Value
Methods
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
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static Participant getDefaultInstance()
Returns
getDefaultInstanceForType()
public Participant getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
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
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
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
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
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
documents_metadata_filters {
key: "market"
value: "US,CA"
}
documents_metadata_filters {
key: "user"
value: "agent"
}
map<string, string> documents_metadata_filters = 8 [(.google.api.field_behavior) = OPTIONAL];
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.
|
getParserForType()
public Parser<Participant> getParserForType()
Returns
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Participant.Builder newBuilder()
Returns
newBuilder(Participant prototype)
public static Participant.Builder newBuilder(Participant prototype)
Parameter
Returns
newBuilderForType()
public Participant.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Participant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Participant parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Participant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Participant parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Participant parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Participant parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Participant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Participant parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Participant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Participant parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Participant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Participant> parser()
Returns
toBuilder()
public Participant.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
