@google-cloud/discoveryengine 1.3.1 → 1.4.1

package/build/protos/google/cloud/discoveryengine/v1/search_service.proto

@@ -48,6 +48,10 @@ service SearchService {
         post: "/v1/{serving_config=projects/*/locations/*/collections/*/dataStores/*/servingConfigs/*}:search"
         body: "*"
       }
+      additional_bindings {
+        post: "/v1/{serving_config=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:search"
+        body: "*"
+      }
     };
   }
 }
@@ -317,6 +321,28 @@ message SearchRequest {
     // A specification for configuring a summary returned in a search
     // response.
     message SummarySpec {
+      // Specification of the prompt to use with the model.
+      message ModelPromptSpec {
+        // Text at the beginning of the prompt that instructs the assistant.
+        // Examples are available in the user guide.
+        string preamble = 1;
+      }
+
+      // Specification of the model.
+      message ModelSpec {
+        // The model version used to generate the summary.
+        //
+        // Supported values are:
+        //
+        // * `stable`: string. Default value when no value is specified. Uses a
+        //   generally available, fine-tuned version of the text-bison@001
+        //   model.
+        // * `preview`: string. (Public preview) Uses a fine-tuned version of
+        //   the text-bison@002 model. This model works only for summaries in
+        //   English.
+        string version = 1;
+      }
+
       // The number of top results to generate the summary from. If the number
       // of results returned is less than `summaryResultCount`, the summary is
       // generated from all of the results.
@@ -368,9 +394,18 @@ message SearchRequest {
       // fallback messages instead.
       bool ignore_non_summary_seeking_query = 4;
 
+      // If specified, the spec will be used to modify the prompt provided to
+      // the LLM.
+      ModelPromptSpec model_prompt_spec = 5;
+
       // Language code for Summary. Use language tags defined by
-      // [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt].
+      // [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
+      // Note: This is an experimental feature.
       string language_code = 6;
+
+      // If specified, the spec will be used to modify the model specification
+      // provided to the LLM.
+      ModelSpec model_spec = 7;
     }
 
     // If `snippetSpec` is not specified, snippets are not included in the
@@ -383,6 +418,8 @@ message SearchRequest {
   }
 
   // Required. The resource name of the Search serving config, such as
+  // `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`,
+  // or
   // `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`.
   // This field is used to identify the serving configuration name, set
   // of models used to make the search.
@@ -440,12 +477,37 @@ message SearchRequest {
   // expression is case-sensitive.
   //
   // If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+  //
+  // Filtering in Vertex AI Search is done by mapping the LHS filter key to a
+  // key property defined in the Vertex AI Search backend -- this mapping is
+  // defined by the customer in their schema. For example a media customer might
+  // have a field 'name' in their schema. In this case the filter would look
+  // like this: filter --> name:'ANY("king kong")'
+  //
+  // For more information about filtering including syntax and filter
+  // operators, see
+  // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
   string filter = 7;
 
+  // The default filter that is applied when a user performs a search without
+  // checking any filters on the search page.
+  //
+  // The filter applied to every search request when quality improvement such as
+  // query expansion is needed. In the case a query does not have a sufficient
+  // amount of results this filter will be used to determine whether or not to
+  // enable the query expansion flow. The original filter will still be used for
+  // the query expanded search.
+  // This field is strongly recommended to achieve high search quality.
+  //
+  // For more information about filter syntax, see
+  // [SearchRequest.filter][google.cloud.discoveryengine.v1.SearchRequest.filter].
+  string canonical_filter = 29;
+
   // The order in which documents are returned. Documents can be ordered by
   // a field in an [Document][google.cloud.discoveryengine.v1.Document] object.
   // Leave it unset if ordered by relevance. `order_by` expression is
-  // case-sensitive.
+  // case-sensitive. For more information on ordering, see
+  // [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
   //
   // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
   string order_by = 8;
@@ -463,6 +525,8 @@ message SearchRequest {
   repeated FacetSpec facet_specs = 9;
 
   // Boost specification to boost certain documents.
+  // For more information on boosting, see
+  // [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
   BoostSpec boost_spec = 10;
 
   // Additional search parameters.
@@ -471,9 +535,17 @@ message SearchRequest {
   //
   // * `user_country_code`: string. Default empty. If set to non-empty, results
   //    are restricted or boosted based on the location provided.
+  //    Example:
+  //    user_country_code: "au"
+  //
+  //    For available codes see [Country
+  //    Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
+  //
   // * `search_type`: double. Default empty. Enables non-webpage searching
-  //   depending on the value. The only valid non-default value is 1,
-  //   which enables image searching.
+  //    depending on the value. The only valid non-default value is 1,
+  //    which enables image searching.
+  //    Example:
+  //    search_type: 1
   map<string, google.protobuf.Value> params = 11;
 
   // The query expansion specification that specifies the conditions under which
@@ -585,6 +657,64 @@ message SearchResponse {
       repeated float scores = 2;
     }
 
+    // Citation metadata.
+    message CitationMetadata {
+      // Citations for segments.
+      repeated Citation citations = 1;
+    }
+
+    // Citation info for a segment.
+    message Citation {
+      // Index indicates the start of the segment, measured in bytes/unicode.
+      int64 start_index = 1;
+
+      // End of the attributed segment, exclusive.
+      int64 end_index = 2;
+
+      // Citation sources for the attributed segment.
+      repeated CitationSource sources = 3;
+    }
+
+    // Citation source.
+    message CitationSource {
+      // Document reference index from SummaryWithMetadata.references.
+      // It is 0-indexed and the value will be zero if the reference_index is
+      // not set explicitly.
+      int64 reference_index = 4;
+    }
+
+    // Document reference.
+    message Reference {
+      // Title of the document.
+      string title = 1;
+
+      // Required.
+      // [Document.name][google.cloud.discoveryengine.v1.Document.name] of the
+      // document. Full resource name of the referenced document, in the format
+      // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+      string document = 2 [
+        (google.api.field_behavior) = REQUIRED,
+        (google.api.resource_reference) = {
+          type: "discoveryengine.googleapis.com/Document"
+        }
+      ];
+
+      // Cloud Storage or HTTP uri for the document.
+      string uri = 3;
+    }
+
+    // Summary with metadata information.
+    message SummaryWithMetadata {
+      // Summary text with no citation information.
+      string summary = 1;
+
+      // Citation metadata for given summary.
+      CitationMetadata citation_metadata = 2;
+
+      // Document References.
+      repeated Reference references = 3;
+    }
+
     // An Enum for summary-skipped reasons.
     enum SummarySkippedReason {
       // Default value. The summary skipped reason is not specified.
@@ -633,6 +763,9 @@ message SearchResponse {
     // A collection of Safety Attribute categories and their associated
     // confidence scores.
     SafetyAttributes safety_attributes = 3;
+
+    // Summary with metadata information.
+    SummaryWithMetadata summary_with_metadata = 4;
   }
 
   // Information describing query expansion including whether expansion has

package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto

@@ -0,0 +1,170 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.discoveryengine.v1;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "SiteSearchEngineProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// SiteSearchEngine captures DataStore level site search persisting
+// configurations. It is a singleton value per data store.
+message SiteSearchEngine {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine"
+  };
+
+  // The fully qualified resource name of the site search engine.
+  // Format: `projects/*/locations/*/dataStores/*/siteSearchEngine`
+  string name = 1;
+}
+
+// A target site for the SiteSearchEngine.
+message TargetSite {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/TargetSite"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}"
+  };
+
+  // Site search indexing failure reasons.
+  message FailureReason {
+    // Failed due to insufficient quota.
+    message QuotaFailure {
+      // This number is an estimation on how much total quota this project needs
+      // to successfully complete indexing.
+      int64 total_required_quota = 1;
+    }
+
+    // Failure reason.
+    oneof failure {
+      // Failed due to insufficient quota.
+      QuotaFailure quota_failure = 1;
+    }
+  }
+
+  // Possible target site types.
+  enum Type {
+    // This value is unused. In this case, server behavior defaults to
+    // [Type.INCLUDE][google.cloud.discoveryengine.v1.TargetSite.Type.INCLUDE].
+    TYPE_UNSPECIFIED = 0;
+
+    // Include the target site.
+    INCLUDE = 1;
+
+    // Exclude the target site.
+    EXCLUDE = 2;
+  }
+
+  // Target site indexing status enumeration.
+  enum IndexingStatus {
+    // Defaults to SUCCEEDED.
+    INDEXING_STATUS_UNSPECIFIED = 0;
+
+    // The target site is in the update queue and will be picked up by indexing
+    // pipeline.
+    PENDING = 1;
+
+    // The target site fails to be indexed.
+    FAILED = 2;
+
+    // The target site has been indexed.
+    SUCCEEDED = 3;
+
+    // The previously indexed target site has been marked to be deleted. This is
+    // a transitioning state which will resulted in either:
+    // 1. target site deleted if unindexing is successful;
+    // 2. state reverts to SUCCEEDED if the unindexing fails.
+    DELETING = 4;
+  }
+
+  // Output only. The fully qualified resource name of the target site.
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`
+  // The `target_site_id` is system-generated.
+  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. Input only. The user provided URI pattern from which the
+  // `generated_uri_pattern` is generated.
+  string provided_uri_pattern = 2 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.field_behavior) = INPUT_ONLY
+  ];
+
+  // The type of the target site, e.g., whether the site is to be included or
+  // excluded.
+  Type type = 3;
+
+  // Input only. If set to false, a uri_pattern is generated to include all
+  // pages whose address contains the provided_uri_pattern. If set to true, an
+  // uri_pattern is generated to try to be an exact match of the
+  // provided_uri_pattern or just the specific page if the provided_uri_pattern
+  // is a specific one. provided_uri_pattern is always normalized to
+  // generate the URI pattern to be used by the search engine.
+  bool exact_match = 6 [(google.api.field_behavior) = INPUT_ONLY];
+
+  // Output only. This is system-generated based on the provided_uri_pattern.
+  string generated_uri_pattern = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Site ownership and validity verification status.
+  SiteVerificationInfo site_verification_info = 7
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indexing status.
+  IndexingStatus indexing_status = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The target site's last updated time.
+  google.protobuf.Timestamp update_time = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Failure reason.
+  FailureReason failure_reason = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Verification information for target sites in advanced site search.
+message SiteVerificationInfo {
+  // Site verification state.
+  enum SiteVerificationState {
+    // Defaults to VERIFIED.
+    SITE_VERIFICATION_STATE_UNSPECIFIED = 0;
+
+    // Site ownership verified.
+    VERIFIED = 1;
+
+    // Site ownership pending verification or verification failed.
+    UNVERIFIED = 2;
+
+    // Site exempt from verification, e.g., a public website that opens to all.
+    EXEMPTED = 3;
+  }
+
+  // Site verification state indicating the ownership and validity.
+  SiteVerificationState site_verification_state = 1;
+
+  // Latest site verification time.
+  google.protobuf.Timestamp verify_time = 2;
+}