@google-cloud/discoveryengine 1.3.0 → 1.4.0

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

@@ -0,0 +1,242 @@
+// 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/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1/engine.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.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 = "EngineServiceProto";
+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";
+
+// Service for managing [Engine][google.cloud.discoveryengine.v1.Engine]
+// configuration.
+service EngineService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Creates a [Engine][google.cloud.discoveryengine.v1.Engine].
+  rpc CreateEngine(CreateEngineRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{parent=projects/*/locations/*/collections/*}/engines"
+      body: "engine"
+    };
+    option (google.api.method_signature) = "parent,engine,engine_id";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1.Engine"
+      metadata_type: "google.cloud.discoveryengine.v1.CreateEngineMetadata"
+    };
+  }
+
+  // Deletes a [Engine][google.cloud.discoveryengine.v1.Engine].
+  rpc DeleteEngine(DeleteEngineRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1/{name=projects/*/locations/*/collections/*/engines/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "google.cloud.discoveryengine.v1.DeleteEngineMetadata"
+    };
+  }
+
+  // Updates an [Engine][google.cloud.discoveryengine.v1.Engine]
+  rpc UpdateEngine(UpdateEngineRequest) returns (Engine) {
+    option (google.api.http) = {
+      patch: "/v1/{engine.name=projects/*/locations/*/collections/*/engines/*}"
+      body: "engine"
+    };
+    option (google.api.method_signature) = "engine,update_mask";
+  }
+
+  // Gets a [Engine][google.cloud.discoveryengine.v1.Engine].
+  rpc GetEngine(GetEngineRequest) returns (Engine) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/collections/*/engines/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all the [Engine][google.cloud.discoveryengine.v1.Engine]s associated
+  // with the project.
+  rpc ListEngines(ListEnginesRequest) returns (ListEnginesResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=projects/*/locations/*/collections/*}/engines"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request for
+// [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine]
+// method.
+message CreateEngineRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Collection"
+    }
+  ];
+
+  // Required. The [Engine][google.cloud.discoveryengine.v1.Engine] to create.
+  Engine engine = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The ID to use for the
+  // [Engine][google.cloud.discoveryengine.v1.Engine], which will become the
+  // final component of the [Engine][google.cloud.discoveryengine.v1.Engine]'s
+  // resource name.
+  //
+  // This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+  // standard with a length limit of 63 characters. Otherwise, an
+  // INVALID_ARGUMENT error is returned.
+  string engine_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Metadata related to the progress of the
+// [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message CreateEngineMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}
+
+// Request message for
+// [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine]
+// method.
+message DeleteEngineRequest {
+  // Required. Full resource name of
+  // [Engine][google.cloud.discoveryengine.v1.Engine], such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+  //
+  // If the caller does not have permission to delete the
+  // [Engine][google.cloud.discoveryengine.v1.Engine], regardless of whether or
+  // not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the [Engine][google.cloud.discoveryengine.v1.Engine] to delete does not
+  // exist, a NOT_FOUND error is returned.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Engine"
+    }
+  ];
+}
+
+// Metadata related to the progress of the
+// [EngineService.DeleteEngine][google.cloud.discoveryengine.v1.EngineService.DeleteEngine]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message DeleteEngineMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}
+
+// Request message for
+// [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
+// method.
+message GetEngineRequest {
+  // Required. Full resource name of
+  // [Engine][google.cloud.discoveryengine.v1.Engine], such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Engine"
+    }
+  ];
+}
+
+// Request message for
+// [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
+// method.
+message ListEnginesRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Collection"
+    }
+  ];
+
+  // Optional. Not supported.
+  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Not supported.
+  string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Filter by solution type. For example:
+  // solution_type=SOLUTION_TYPE_SEARCH
+  string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response message for
+// [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
+// method.
+message ListEnginesResponse {
+  // All the customer's [Engine][google.cloud.discoveryengine.v1.Engine]s.
+  repeated Engine engines = 1;
+
+  // Not supported.
+  string next_page_token = 2;
+}
+
+// Request message for
+// [EngineService.UpdateEngine][google.cloud.discoveryengine.v1.EngineService.UpdateEngine]
+// method.
+message UpdateEngineRequest {
+  // Required. The [Engine][google.cloud.discoveryengine.v1.Engine] to update.
+  //
+  // If the caller does not have permission to update the
+  // [Engine][google.cloud.discoveryengine.v1.Engine], regardless of whether or
+  // not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the [Engine][google.cloud.discoveryengine.v1.Engine] to update does not
+  // exist, a NOT_FOUND error is returned.
+  Engine engine = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided
+  // [Engine][google.cloud.discoveryengine.v1.Engine] to update.
+  //
+  // If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+  // is returned.
+  google.protobuf.FieldMask update_mask = 2;
+}

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

@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1;
 
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1/completion.proto";
 import "google/cloud/discoveryengine/v1/document.proto";
 import "google/cloud/discoveryengine/v1/user_event.proto";
 import "google/protobuf/timestamp.proto";
@@ -336,3 +337,66 @@ message ImportDocumentsResponse {
   // Echoes the destination for the complete errors in the request if set.
   ImportErrorConfig error_config = 2;
 }
+
+// Request message for
+// [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries]
+// method.
+message ImportSuggestionDenyListEntriesRequest {
+  // The inline source for SuggestionDenyListEntry.
+  message InlineSource {
+    // Required. A list of all denylist entries to import. Max of 1000 items.
+    repeated SuggestionDenyListEntry entries = 1
+        [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // The source of the updated SuggestionDenyList.
+  oneof source {
+    // The Inline source for the input content for suggestion deny list entries.
+    InlineSource inline_source = 2;
+
+    // Cloud Storage location for the input content.
+    //
+    // Only 1 file can be specified that contains all entries to import.
+    // Supported values `gcs_source.schema` for autocomplete suggestion deny
+    // list entry imports:
+    //
+    // * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
+    // per line.
+    GcsSource gcs_source = 3;
+  }
+
+  // Required. The parent data store resource name for which to import denylist
+  // entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+}
+
+// Response message for
+// [CompletionService.ImportSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.ImportSuggestionDenyListEntries]
+// method.
+message ImportSuggestionDenyListEntriesResponse {
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 1;
+
+  // Count of deny list entries successfully imported.
+  int64 imported_entries_count = 2;
+
+  // Count of deny list entries that failed to be imported.
+  int64 failed_entries_count = 3;
+}
+
+// Metadata related to the progress of the ImportSuggestionDenyListEntries
+// operation. This is returned by the google.longrunning.Operation.metadata
+// field.
+message ImportSuggestionDenyListEntriesMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}

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

@@ -19,6 +19,7 @@ package google.cloud.discoveryengine.v1;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
 option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
@@ -84,3 +85,40 @@ message PurgeDocumentsMetadata {
   // Count of entries that encountered errors while processing.
   int64 failure_count = 4;
 }
+
+// Request message for
+// [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries]
+// method.
+message PurgeSuggestionDenyListEntriesRequest {
+  // Required. The parent data store resource name for which to import denylist
+  // entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+}
+
+// Response message for
+// [CompletionService.PurgeSuggestionDenyListEntries][google.cloud.discoveryengine.v1.CompletionService.PurgeSuggestionDenyListEntries]
+// method.
+message PurgeSuggestionDenyListEntriesResponse {
+  // Number of suggestion deny list entries purged.
+  int64 purge_count = 1;
+
+  // A sample of errors encountered while processing the request.
+  repeated google.rpc.Status error_samples = 2;
+}
+
+// Metadata related to the progress of the PurgeSuggestionDenyListEntries
+// operation. This is returned by the google.longrunning.Operation.metadata
+// field.
+message PurgeSuggestionDenyListEntriesMetadata {
+  // Operation create time.
+  google.protobuf.Timestamp create_time = 1;
+
+  // Operation last update time. If the operation is done, this is also the
+  // finish time.
+  google.protobuf.Timestamp update_time = 2;
+}

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