feat: add lite search API to allow public website search with API key

Google APIs · copybara-github · commit 537fd482f6bb · 2024-10-24T18:31:12.000-07:00
feat: add LOW_GROUNDED_ANSWER in answer skip reasons
feat: support query regex in control match rules
docs: keep the API doc up-to-date with recent changes

PiperOrigin-RevId: 689588291
diff --git a/google/cloud/discoveryengine/v1/answer.proto b/google/cloud/discoveryengine/v1/answer.proto
@@ -363,6 +363,12 @@ message Answer {
     //
     // Google skips the answer if the query doesn't have clear intent.
     NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8;
+
+    // The low-grounded answer case.
+    //
+    // Google skips the answer if a well grounded answer was unable to be
+    // generated.
+    LOW_GROUNDED_ANSWER = 9;
   }
 
   // Immutable. Fully qualified name
diff --git a/google/cloud/discoveryengine/v1/control.proto b/google/cloud/discoveryengine/v1/control.proto
@@ -62,6 +62,9 @@ message Condition {
 
   // Search only
   // A list of terms to match the query on.
+  // Cannot be set when
+  // [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex]
+  // is set.
   //
   // Maximum of 10 query terms.
   repeated QueryTerm query_terms = 2;
@@ -70,6 +73,12 @@ message Condition {
   //
   // Maximum of 10 time ranges.
   repeated TimeRange active_time_range = 3;
+
+  // Optional. Query regex to match the whole search query.
+  // Cannot be set when
+  // [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms]
+  // is set. This is currently supporting promotion use case.
+  string query_regex = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Defines a conditioned behavior to employ during serving.
diff --git a/google/cloud/discoveryengine/v1/discoveryengine_v1.yaml b/google/cloud/discoveryengine/v1/discoveryengine_v1.yaml
@@ -164,6 +164,10 @@ authentication:
     oauth:
       canonical_scopes: |-
         https://www.googleapis.com/auth/cloud-platform
+  - selector: google.cloud.discoveryengine.v1.SearchService.SearchLite
+    oauth:
+      canonical_scopes: |-
+        https://www.googleapis.com/auth/cloud-platform
   - selector: google.cloud.discoveryengine.v1.SearchTuningService.ListCustomModels
     oauth:
       canonical_scopes: |-
diff --git a/google/cloud/discoveryengine/v1/document_service.proto b/google/cloud/discoveryengine/v1/document_service.proto
@@ -402,13 +402,11 @@ message BatchGetDocumentsMetadataResponse {
         // [Document][google.cloud.discoveryengine.v1.Document].
         string uri = 1;
 
-        // Required. Format:
+        // Format:
         // projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}
-        string fhir_resource = 2 [
-          (google.api.resource_reference) = {
-            type: "healthcare.googleapis.com/FhirResource"
-          }
-        ];
+        string fhir_resource = 2 [(google.api.resource_reference) = {
+          type: "healthcare.googleapis.com/FhirResource"
+        }];
       }
     }
 
diff --git a/google/cloud/discoveryengine/v1/search_service.proto b/google/cloud/discoveryengine/v1/search_service.proto
@@ -55,6 +55,34 @@ service SearchService {
       }
     };
   }
+
+  // Performs a search. Similar to the
+  // [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
+  // method, but a lite version that allows API key for authentication, where
+  // OAuth and IAM checks are not required.
+  //
+  // Only public website search is supported by this method. If data stores and
+  // engines not associated with public website search are specified, a
+  // `FAILED_PRECONDITION` error is returned.
+  //
+  // This method can be used for easy onboarding without having to implement an
+  // authentication backend. However, it is strongly recommended to use
+  // [SearchService.Search][google.cloud.discoveryengine.v1.SearchService.Search]
+  // instead with required OAuth and IAM checks to provide better data security.
+  rpc SearchLite(SearchRequest) returns (SearchResponse) {
+    option (google.api.http) = {
+      post: "/v1/{serving_config=projects/*/locations/*/dataStores/*/servingConfigs/*}:searchLite"
+      body: "*"
+      additional_bindings {
+        post: "/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:searchLite"
+        body: "*"
+      }
+      additional_bindings {
+        post: "/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:searchLite"
+        body: "*"
+      }
+    };
+  }
 }
 
 // Request message for
