Package com.google.cloud.dialogflow.v2

Interface ParticipantOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Participant, Participant.Builder
@Generated public interface ParticipantOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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:
      The name.

    • getNameBytes

      com.google.protobuf.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:
      The bytes for name.

    • getRoleValue

      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.v2.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for role.

    • getRole

      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.v2.Participant.Role role = 2 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The role.

    • getSipRecordingMediaLabel

      String getSipRecordingMediaLabel()
       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.
      string sip_recording_media_label = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The sipRecordingMediaLabel.

    • getSipRecordingMediaLabelBytes

      com.google.protobuf.ByteString getSipRecordingMediaLabelBytes()
       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.
      string sip_recording_media_label = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for sipRecordingMediaLabel.

    • getObfuscatedExternalUserId

      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.v2.CreateParticipantRequest.participant]
 or
 [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
 Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
 [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.participant]
 or
 [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant],
 Dialogflow will update
 [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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.
      string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The obfuscatedExternalUserId.

    • getObfuscatedExternalUserIdBytes

      com.google.protobuf.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.v2.CreateParticipantRequest.participant]
 or
 [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant],
 Dialogflow adds the obfuscated user id with the participant.

 2. If you set this field in
 [AnalyzeContent][google.cloud.dialogflow.v2.AnalyzeContentRequest.participant]
 or
 [StreamingAnalyzeContent][google.cloud.dialogflow.v2.StreamingAnalyzeContentRequest.participant],
 Dialogflow will update
 [Participant.obfuscated_external_user_id][google.cloud.dialogflow.v2.Participant.obfuscated_external_user_id].

 Dialogflow returns an error if you try to add a user id for a
 non-[END_USER][google.cloud.dialogflow.v2.Participant.Role.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.
      string obfuscated_external_user_id = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for obfuscatedExternalUserId.

    • getDocumentsMetadataFiltersCount

      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][google.cloud.dialogflow.v2.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

      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.v2.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];

    • getDocumentsMetadataFilters

      @Deprecated Map<String,String> getDocumentsMetadataFilters()
      Deprecated.
      Use getDocumentsMetadataFiltersMap() instead.

    • getDocumentsMetadataFiltersMap

      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.v2.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

      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.v2.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

      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.v2.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];

    • getAgentDesktopSourceValue

      int getAgentDesktopSourceValue()
       Optional. For tracking the utilization of prebuilt Agent Assist integration
 modules. This field is only inscope for Integration type that include UI
 Modules, Backend Modules, and Agent Desktop connector, it is out of scope
 for CCaaS and Direct Integration.
 For each human agent, prebuilt UI Modules needs to trigger the
 UpdateParticipant API to update this field. Both
 [CreateParticipantRequest][google.cloud.dialogflow.v2.CreateParticipantRequest.participant]
 and
 [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant]
 will be supported.
      .google.cloud.dialogflow.v2.Participant.AgentDesktopSource agent_desktop_source = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for agentDesktopSource.

    • getAgentDesktopSource

      Participant.AgentDesktopSource getAgentDesktopSource()
       Optional. For tracking the utilization of prebuilt Agent Assist integration
 modules. This field is only inscope for Integration type that include UI
 Modules, Backend Modules, and Agent Desktop connector, it is out of scope
 for CCaaS and Direct Integration.
 For each human agent, prebuilt UI Modules needs to trigger the
 UpdateParticipant API to update this field. Both
 [CreateParticipantRequest][google.cloud.dialogflow.v2.CreateParticipantRequest.participant]
 and
 [UpdateParticipantRequest][google.cloud.dialogflow.v2.UpdateParticipantRequest.participant]
 will be supported.
      .google.cloud.dialogflow.v2.Participant.AgentDesktopSource agent_desktop_source = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The agentDesktopSource.