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| Modifier and Type | Class and Description |
|---|---|
static class |
Participant.Builder
Represents a conversation participant (human agent, virtual agent, end-user).
|
static class |
Participant.Role
Enumeration of the roles a participant can play in a conversation.
|
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameterAbstractMessageLite.InternalOneOfEnum| Modifier and Type | Field and Description |
|---|---|
static int |
DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER |
static int |
ROLE_FIELD_NUMBER |
alwaysUseFieldBuilders, unknownFieldsmemoizedSizememoizedHashCodecanUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneoftoByteArray, toByteString, writeDelimitedTo, writeTopublic static final int NAME_FIELD_NUMBER
public static final int ROLE_FIELD_NUMBER
public static final int OBFUSCATED_EXTERNAL_USER_ID_FIELD_NUMBER
public static final int DOCUMENTS_METADATA_FILTERS_FIELD_NUMBER
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class GeneratedMessageV3public final UnknownFieldSet getUnknownFields()
getUnknownFields in interface MessageOrBuildergetUnknownFields in class GeneratedMessageV3public static final Descriptors.Descriptor getDescriptor()
protected MapField internalGetMapField(int number)
internalGetMapField in class GeneratedMessageV3protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class GeneratedMessageV3public 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];getName in interface ParticipantOrBuilderpublic 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];getNameBytes in interface ParticipantOrBuilderpublic 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];
getRoleValue in interface ParticipantOrBuilderpublic 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];
getRole in interface ParticipantOrBuilderpublic String getObfuscatedExternalUserId()
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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant] or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id] or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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];getObfuscatedExternalUserId in interface ParticipantOrBuilderpublic ByteString getObfuscatedExternalUserIdBytes()
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][google.cloud.dialogflow.v2beta1.CreateParticipantRequest.participant] or
[UpdateParticipantRequest][google.cloud.dialogflow.v2beta1.UpdateParticipantRequest.participant],
Dialogflow adds the obfuscated user id with the participant.
2. If you set this field in
[AnalyzeContent][google.cloud.dialogflow.v2beta1.AnalyzeContentRequest.obfuscated_external_user_id] or
[StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.obfuscated_external_user_id],
Dialogflow will update [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2beta1.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];getObfuscatedExternalUserIdBytes in interface ParticipantOrBuilderpublic int getDocumentsMetadataFiltersCount()
ParticipantOrBuilder
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][google.cloud.dialogflow.v2beta1.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];
getDocumentsMetadataFiltersCount in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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];
containsDocumentsMetadataFilters in interface ParticipantOrBuilder@Deprecated public Map<String,String> getDocumentsMetadataFilters()
getDocumentsMetadataFiltersMap() instead.getDocumentsMetadataFilters in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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];
getDocumentsMetadataFiltersMap in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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];
getDocumentsMetadataFiltersOrDefault in interface ParticipantOrBuilderpublic 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][google.cloud.dialogflow.v2beta1.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];
getDocumentsMetadataFiltersOrThrow in interface ParticipantOrBuilderpublic final boolean isInitialized()
isInitialized in interface MessageLiteOrBuilderisInitialized in class GeneratedMessageV3public void writeTo(CodedOutputStream output) throws IOException
writeTo in interface MessageLitewriteTo in class GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface MessageLitegetSerializedSize in class GeneratedMessageV3public boolean equals(Object obj)
equals in interface Messageequals in class AbstractMessagepublic int hashCode()
hashCode in interface MessagehashCode in class AbstractMessagepublic static Participant parseFrom(ByteBuffer data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(ByteString data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(byte[] data) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) throws InvalidProtocolBufferException
InvalidProtocolBufferExceptionpublic static Participant parseFrom(InputStream input) throws IOException
IOExceptionpublic static Participant parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Participant parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Participant parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Participant parseFrom(CodedInputStream input) throws IOException
IOExceptionpublic static Participant parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Participant.Builder newBuilderForType()
newBuilderForType in interface MessagenewBuilderForType in interface MessageLitepublic static Participant.Builder newBuilder()
public static Participant.Builder newBuilder(Participant prototype)
public Participant.Builder toBuilder()
toBuilder in interface MessagetoBuilder in interface MessageLiteprotected Participant.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class GeneratedMessageV3public static Participant getDefaultInstance()
public static Parser<Participant> parser()
public Parser<Participant> getParserForType()
getParserForType in interface MessagegetParserForType in interface MessageLitegetParserForType in class GeneratedMessageV3public Participant getDefaultInstanceForType()
getDefaultInstanceForType in interface MessageLiteOrBuildergetDefaultInstanceForType in interface MessageOrBuilderCopyright © 2022 Google LLC. All rights reserved.