feat: support document metadata filter in article suggestion (#773)

- [ ] Regenerate this pull request now. PiperOrigin-RevId: 410295622 Source-Link: googleapis/googleapis@dfa9d62 Source-Link: googleapis/googleapis-gen@0096968 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA5Njk2OGIxZmUwZDY3Y2E4NzgxODc0MzZlNDA2YjAxNmUyN2EwZCJ9
googleapis · Nov 17, 2021 · 24afa13 · 24afa13
1 parent a615d5e
commit 24afa13
Show file tree

Hide file tree

Showing 38 changed files with 3,900 additions and 662 deletions.
diff --git a/...loud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2beta1/ParticipantsClient.java b/...loud-dialogflow/src/main/java/com/google/cloud/dialogflow/v2beta1/ParticipantsClient.java
@@ -754,6 +754,7 @@ public final AnalyzeContentResponse analyzeContent(String participant, TextInput
    *                   .toString())
    *           .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
    *           .setQueryParams(QueryParameters.newBuilder().build())
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .setMessageSendTime(Timestamp.newBuilder().build())
    *           .setRequestId("requestId693933066")
    *           .build();
@@ -788,6 +789,7 @@ public final AnalyzeContentResponse analyzeContent(AnalyzeContentRequest request
    *                   .toString())
    *           .setReplyAudioConfig(OutputAudioConfig.newBuilder().build())
    *           .setQueryParams(QueryParameters.newBuilder().build())
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .setMessageSendTime(Timestamp.newBuilder().build())
    *           .setRequestId("requestId693933066")
    *           .build();
@@ -891,6 +893,7 @@ public final SuggestArticlesResponse suggestArticles(String parent) {
    *                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
    *                   .toString())
    *           .setContextSize(1116903569)
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .build();
    *   SuggestArticlesResponse response = participantsClient.suggestArticles(request);
    * }
@@ -927,6 +930,7 @@ public final SuggestArticlesResponse suggestArticles(SuggestArticlesRequest requ
    *                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
    *                   .toString())
    *           .setContextSize(1116903569)
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .build();
    *   ApiFuture<SuggestArticlesResponse> future =
    *       participantsClient.suggestArticlesCallable().futureCall(request);
@@ -1014,6 +1018,7 @@ public final SuggestFaqAnswersResponse suggestFaqAnswers(String parent) {
    *                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
    *                   .toString())
    *           .setContextSize(1116903569)
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .build();
    *   SuggestFaqAnswersResponse response = participantsClient.suggestFaqAnswers(request);
    * }
@@ -1045,6 +1050,7 @@ public final SuggestFaqAnswersResponse suggestFaqAnswers(SuggestFaqAnswersReques
    *                       "[PROJECT]", "[CONVERSATION]", "[MESSAGE]")
    *                   .toString())
    *           .setContextSize(1116903569)
+   *           .setAssistQueryParams(AssistQueryParameters.newBuilder().build())
    *           .build();
    *   ApiFuture<SuggestFaqAnswersResponse> future =
    *       participantsClient.suggestFaqAnswersCallable().futureCall(request);

diff --git a/...-dialogflow/src/test/java/com/google/cloud/dialogflow/v2beta1/ParticipantsClientTest.java b/...-dialogflow/src/test/java/com/google/cloud/dialogflow/v2beta1/ParticipantsClientTest.java
@@ -33,6 +33,7 @@
 import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.HashMap;
 import java.util.List;
 import java.util.UUID;
 import javax.annotation.Generated;
@@ -90,6 +91,7 @@ public void createParticipantTest() throws Exception {
                         "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                     .toString())
             .setObfuscatedExternalUserId("obfuscatedExternalUserId1778228693")
+            .putAllDocumentsMetadataFilters(new HashMap<String, String>())
             .build();
     mockParticipants.addResponse(expectedResponse);
 
@@ -137,6 +139,7 @@ public void createParticipantTest2() throws Exception {
                         "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                     .toString())
             .setObfuscatedExternalUserId("obfuscatedExternalUserId1778228693")
+            .putAllDocumentsMetadataFilters(new HashMap<String, String>())
             .build();
     mockParticipants.addResponse(expectedResponse);
 
@@ -182,6 +185,7 @@ public void getParticipantTest() throws Exception {
                         "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                     .toString())
             .setObfuscatedExternalUserId("obfuscatedExternalUserId1778228693")
+            .putAllDocumentsMetadataFilters(new HashMap<String, String>())
             .build();
     mockParticipants.addResponse(expectedResponse);
 
@@ -228,6 +232,7 @@ public void getParticipantTest2() throws Exception {
                         "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                     .toString())
             .setObfuscatedExternalUserId("obfuscatedExternalUserId1778228693")
+            .putAllDocumentsMetadataFilters(new HashMap<String, String>())
             .build();
     mockParticipants.addResponse(expectedResponse);
 
@@ -360,6 +365,7 @@ public void updateParticipantTest() throws Exception {
                         "[PROJECT]", "[CONVERSATION]", "[PARTICIPANT]")
                     .toString())
             .setObfuscatedExternalUserId("obfuscatedExternalUserId1778228693")
+            .putAllDocumentsMetadataFilters(new HashMap<String, String>())
             .build();
     mockParticipants.addResponse(expectedResponse);
 

diff --git a/...ialogflow-v2beta1/src/main/java/com/google/cloud/dialogflow/v2beta1/ParticipantsGrpc.java b/...ialogflow-v2beta1/src/main/java/com/google/cloud/dialogflow/v2beta1/ParticipantsGrpc.java
@@ -21,7 +21,8 @@
  *
  *
  * <pre>
- * Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].
+ * Service for managing
+ * [Participants][google.cloud.dialogflow.v2beta1.Participant].
  * </pre>
  */
 @javax.annotation.Generated(
@@ -549,7 +550,8 @@ public ParticipantsFutureStub newStub(
    *
    *
    * <pre>
-   * Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].
+   * Service for managing
+   * [Participants][google.cloud.dialogflow.v2beta1.Participant].
    * </pre>
    */
   public abstract static class ParticipantsImplBase implements io.grpc.BindableService {
@@ -639,9 +641,12 @@ public void analyzeContent(
      * <pre>
      * Gets suggested articles for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     public void suggestArticles(
@@ -690,9 +695,9 @@ public void suggestSmartReplies(
      * <pre>
      * Deprecated: Use inline suggestion, event based suggestion or
      * Suggestion* API instead.
-     * See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more
-     * details.
-     * Removal Date: 2020-09-01.
+     * See
+     * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
+     * for more details. Removal Date: 2020-09-01.
      * Retrieves suggestions for live agents.
      * This method should be used by human agent client software to fetch auto
      * generated suggestions in real-time, while the conversation with an end user
@@ -721,12 +726,19 @@ public void listSuggestions(
      *
      *
      * <pre>
-     * Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.
+     * Deprecated. use
+     * [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]
+     * and
+     * [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]
+     * instead.
      * Gets suggestions for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     @java.lang.Deprecated
@@ -819,7 +831,8 @@ public final io.grpc.ServerServiceDefinition bindService() {
    *
    *
    * <pre>
-   * Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].
+   * Service for managing
+   * [Participants][google.cloud.dialogflow.v2beta1.Participant].
    * </pre>
    */
   public static final class ParticipantsStub
@@ -928,9 +941,12 @@ public void analyzeContent(
      * <pre>
      * Gets suggested articles for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     public void suggestArticles(
@@ -985,9 +1001,9 @@ public void suggestSmartReplies(
      * <pre>
      * Deprecated: Use inline suggestion, event based suggestion or
      * Suggestion* API instead.
-     * See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more
-     * details.
-     * Removal Date: 2020-09-01.
+     * See
+     * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
+     * for more details. Removal Date: 2020-09-01.
      * Retrieves suggestions for live agents.
      * This method should be used by human agent client software to fetch auto
      * generated suggestions in real-time, while the conversation with an end user
@@ -1018,12 +1034,19 @@ public void listSuggestions(
      *
      *
      * <pre>
-     * Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.
+     * Deprecated. use
+     * [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]
+     * and
+     * [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]
+     * instead.
      * Gets suggestions for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     @java.lang.Deprecated
@@ -1042,7 +1065,8 @@ public void compileSuggestion(
    *
    *
    * <pre>
-   * Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].
+   * Service for managing
+   * [Participants][google.cloud.dialogflow.v2beta1.Participant].
    * </pre>
    */
   public static final class ParticipantsBlockingStub
@@ -1132,9 +1156,12 @@ public com.google.cloud.dialogflow.v2beta1.AnalyzeContentResponse analyzeContent
      * <pre>
      * Gets suggested articles for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     public com.google.cloud.dialogflow.v2beta1.SuggestArticlesResponse suggestArticles(
@@ -1177,9 +1204,9 @@ public com.google.cloud.dialogflow.v2beta1.SuggestSmartRepliesResponse suggestSm
      * <pre>
      * Deprecated: Use inline suggestion, event based suggestion or
      * Suggestion* API instead.
-     * See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more
-     * details.
-     * Removal Date: 2020-09-01.
+     * See
+     * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
+     * for more details. Removal Date: 2020-09-01.
      * Retrieves suggestions for live agents.
      * This method should be used by human agent client software to fetch auto
      * generated suggestions in real-time, while the conversation with an end user
@@ -1206,12 +1233,19 @@ public com.google.cloud.dialogflow.v2beta1.ListSuggestionsResponse listSuggestio
      *
      *
      * <pre>
-     * Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.
+     * Deprecated. use
+     * [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]
+     * and
+     * [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]
+     * instead.
      * Gets suggestions for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     @java.lang.Deprecated
@@ -1226,7 +1260,8 @@ public com.google.cloud.dialogflow.v2beta1.CompileSuggestionResponse compileSugg
    *
    *
    * <pre>
-   * Service for managing [Participants][google.cloud.dialogflow.v2beta1.Participant].
+   * Service for managing
+   * [Participants][google.cloud.dialogflow.v2beta1.Participant].
    * </pre>
    */
   public static final class ParticipantsFutureStub
@@ -1321,9 +1356,12 @@ protected ParticipantsFutureStub build(
      * <pre>
      * Gets suggested articles for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     public com.google.common.util.concurrent.ListenableFuture<
@@ -1370,9 +1408,9 @@ protected ParticipantsFutureStub build(
      * <pre>
      * Deprecated: Use inline suggestion, event based suggestion or
      * Suggestion* API instead.
-     * See [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name] for more
-     * details.
-     * Removal Date: 2020-09-01.
+     * See
+     * [HumanAgentAssistantConfig.name][google.cloud.dialogflow.v2beta1.HumanAgentAssistantConfig.name]
+     * for more details. Removal Date: 2020-09-01.
      * Retrieves suggestions for live agents.
      * This method should be used by human agent client software to fetch auto
      * generated suggestions in real-time, while the conversation with an end user
@@ -1400,12 +1438,19 @@ protected ParticipantsFutureStub build(
      *
      *
      * <pre>
-     * Deprecated. use [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles] and [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers] instead.
+     * Deprecated. use
+     * [SuggestArticles][google.cloud.dialogflow.v2beta1.Participants.SuggestArticles]
+     * and
+     * [SuggestFaqAnswers][google.cloud.dialogflow.v2beta1.Participants.SuggestFaqAnswers]
+     * instead.
      * Gets suggestions for a participant based on specific historical
      * messages.
-     * Note that [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions] will only list the auto-generated
-     * suggestions, while [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion] will try to compile suggestion
-     * based on the provided conversation context in the real time.
+     * Note that
+     * [ListSuggestions][google.cloud.dialogflow.v2beta1.Participants.ListSuggestions]
+     * will only list the auto-generated suggestions, while
+     * [CompileSuggestion][google.cloud.dialogflow.v2beta1.Participants.CompileSuggestion]
+     * will try to compile suggestion based on the provided conversation context
+     * in the real time.
      * </pre>
      */
     @java.lang.Deprecated