@google-cloud/discoveryengine 1.3.1 → 1.4.1

package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto

@@ -0,0 +1,120 @@
+// 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.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/common.proto";
+import "google/cloud/discoveryengine/v1beta/document_processing_config.proto";
+import "google/cloud/discoveryengine/v1beta/schema.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "DataStoreProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// DataStore captures global settings and configs at the DataStore level.
+message DataStore {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/DataStore"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}"
+  };
+
+  // Content config of the data store.
+  enum ContentConfig {
+    // Default value.
+    CONTENT_CONFIG_UNSPECIFIED = 0;
+
+    // Only contains documents without any
+    // [Document.content][google.cloud.discoveryengine.v1beta.Document.content].
+    NO_CONTENT = 1;
+
+    // Only contains documents with
+    // [Document.content][google.cloud.discoveryengine.v1beta.Document.content].
+    CONTENT_REQUIRED = 2;
+
+    // The data store is used for public website search.
+    PUBLIC_WEBSITE = 3;
+  }
+
+  // Immutable. The full resource name of the data store.
+  // Format:
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Required. The data store display name.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 128
+  // characters. Otherwise, an INVALID_ARGUMENT error is returned.
+  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Immutable. The industry vertical that the data store registers.
+  IndustryVertical industry_vertical = 3
+      [(google.api.field_behavior) = IMMUTABLE];
+
+  // The solutions that the data store enrolls. Available solutions for each
+  // [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.industry_vertical]:
+  //
+  // * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`.
+  // * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other
+  //   solutions cannot be enrolled.
+  repeated SolutionType solution_types = 5;
+
+  // Output only. The id of the default
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema] asscociated to this
+  // data store.
+  string default_schema_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Immutable. The content config of the data store. If this field is unset,
+  // the server behavior defaults to
+  // [ContentConfig.NO_CONTENT][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.NO_CONTENT].
+  ContentConfig content_config = 6 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Output only. Timestamp the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
+  google.protobuf.Timestamp create_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Configuration for Document understanding and enrichment.
+  DocumentProcessingConfig document_processing_config = 27;
+
+  // The start schema to use for this
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore] when
+  // provisioning it. If unset, a default vertical specialized schema will be
+  // used.
+  //
+  // This field is only used by [CreateDataStore][] API, and will be ignored if
+  // used in other APIs. This field will be omitted from all API responses
+  // including [CreateDataStore][] API. To retrieve a schema of a
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], use
+  // [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
+  // API instead.
+  //
+  // The provided schema will be validated against certain rules on schema.
+  // Learn more from [this
+  // doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema).
+  Schema starting_schema = 28;
+}

package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto

@@ -0,0 +1,306 @@
+// 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.v1beta;
+
+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/v1beta/data_store.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.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "DataStoreServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// Service for managing
+// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] configuration.
+service DataStoreService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Creates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
+  //
+  // DataStore is for storing
+  // [Documents][google.cloud.discoveryengine.v1beta.Document]. To serve these
+  // documents for Search, or Recommendation use case, an
+  // [Engine][google.cloud.discoveryengine.v1beta.Engine] needs to be created
+  // separately.
+  rpc CreateDataStore(CreateDataStoreRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*}/dataStores"
+      body: "data_store"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*}/dataStores"
+        body: "data_store"
+      }
+    };
+    option (google.api.method_signature) = "parent,data_store,data_store_id";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.DataStore"
+      metadata_type: "google.cloud.discoveryengine.v1beta.CreateDataStoreMetadata"
+    };
+  }
+
+  // Gets a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
+  rpc GetDataStore(GetDataStoreRequest) returns (DataStore) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=projects/*/locations/*/dataStores/*}"
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all the [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s
+  // associated with the project.
+  rpc ListDataStores(ListDataStoresRequest) returns (ListDataStoresResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*}/dataStores"
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*}/dataStores"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Deletes a [DataStore][google.cloud.discoveryengine.v1beta.DataStore].
+  rpc DeleteDataStore(DeleteDataStoreRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1beta/{name=projects/*/locations/*/dataStores/*}"
+      additional_bindings {
+        delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata"
+    };
+  }
+
+  // Updates a [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
+  rpc UpdateDataStore(UpdateDataStoreRequest) returns (DataStore) {
+    option (google.api.http) = {
+      patch: "/v1beta/{data_store.name=projects/*/locations/*/dataStores/*}"
+      body: "data_store"
+      additional_bindings {
+        patch: "/v1beta/{data_store.name=projects/*/locations/*/collections/*/dataStores/*}"
+        body: "data_store"
+      }
+    };
+    option (google.api.method_signature) = "data_store,update_mask";
+  }
+}
+
+// Request for
+// [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
+// method.
+message CreateDataStoreRequest {
+  // 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 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
+  // create.
+  DataStore data_store = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The ID to use for the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], which will
+  // become the final component of the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]'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 data_store_id = 3 [(google.api.field_behavior) = REQUIRED];
+
+  // A boolean flag indicating whether user want to directly create an advanced
+  // data store for site search.
+  // If the data store is not configured as site
+  // search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
+  // be ignored.
+  bool create_advanced_site_search = 4;
+}
+
+// Request message for
+// [DataStoreService.GetDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.GetDataStore]
+// method.
+message GetDataStoreRequest {
+  // Required. Full resource name of
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+  //
+  // If the caller does not have permission to access the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
+  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the requested [DataStore][google.cloud.discoveryengine.v1beta.DataStore]
+  // 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/DataStore"
+    }
+  ];
+}
+
+// Metadata related to the progress of the
+// [DataStoreService.CreateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.CreateDataStore]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message CreateDataStoreMetadata {
+  // 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
+// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
+// method.
+message ListDataStoresRequest {
+  // Required. The parent branch resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}`.
+  //
+  // If the caller does not have permission to list
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s under this
+  // location, regardless of whether or not this data store exists, a
+  // PERMISSION_DENIED error is returned.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Collection"
+    }
+  ];
+
+  // Maximum number of
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s to return. If
+  // unspecified, defaults to 10. The maximum allowed value is 50. Values above
+  // 50 will be coerced to 50.
+  //
+  // If this field is negative, an INVALID_ARGUMENT is returned.
+  int32 page_size = 2;
+
+  // A page token
+  // [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token],
+  // received from a previous
+  // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to
+  // [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
+  // must match the call that provided the page token. Otherwise, an
+  // INVALID_ARGUMENT error is returned.
+  string page_token = 3;
+
+  // Filter by solution type. For example: filter =
+  // 'solution_type:SOLUTION_TYPE_SEARCH'
+  string filter = 4;
+}
+
+// Response message for
+// [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores]
+// method.
+message ListDataStoresResponse {
+  // All the customer's
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s.
+  repeated DataStore data_stores = 1;
+
+  // A token that can be sent as
+  // [ListDataStoresRequest.page_token][google.cloud.discoveryengine.v1beta.ListDataStoresRequest.page_token]
+  // to retrieve the next page. If this field is omitted, there are no
+  // subsequent pages.
+  string next_page_token = 2;
+}
+
+// Request message for
+// [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore]
+// method.
+message DeleteDataStoreRequest {
+  // Required. Full resource name of
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], such as
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+  //
+  // If the caller does not have permission to delete the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
+  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] 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/DataStore"
+    }
+  ];
+}
+
+// Request message for
+// [DataStoreService.UpdateDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.UpdateDataStore]
+// method.
+message UpdateDataStoreRequest {
+  // Required. The [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to
+  // update.
+  //
+  // If the caller does not have permission to update the
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore], regardless of
+  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  //
+  // If the [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update
+  // does not exist, a NOT_FOUND error is returned.
+  DataStore data_store = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore] to update.
+  //
+  // If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
+  // is returned.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+// Metadata related to the progress of the
+// [DataStoreService.DeleteDataStore][google.cloud.discoveryengine.v1beta.DataStoreService.DeleteDataStore]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message DeleteDataStoreMetadata {
+  // 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/v1beta/document.proto

@@ -19,6 +19,7 @@ package google.cloud.discoveryengine.v1beta;
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/struct.proto";
+import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
 option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
@@ -53,7 +54,7 @@ message Document {
 
       // The URI of the content. Only Cloud Storage URIs (e.g.
       // `gs://bucket-name/path/to/file`) are supported. The maximum file size
-      // is 100 MB.
+      // is 2.5 MB for text-based formats, 100 MB for other formats.
       string uri = 3;
     }
 
@@ -118,4 +119,12 @@ message Document {
   // It contains derived data that are not in the original input document.
   google.protobuf.Struct derived_struct_data = 6
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The last time the document was indexed. If this field is set,
+  // the document could be returned in search results.
+  //
+  // This field is OUTPUT_ONLY. If this field is not populated, it means the
+  // document has never been indexed.
+  google.protobuf.Timestamp index_time = 13
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }

package/build/protos/google/cloud/discoveryengine/v1beta/document_processing_config.proto

@@ -0,0 +1,94 @@
+// 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.v1beta;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "DocumentProcessingConfigProto";
+option java_package = "com.google.cloud.discoveryengine.v1beta";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1beta";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1beta";
+
+// A singleton resource of
+// [DataStore][google.cloud.discoveryengine.v1beta.DataStore]. It's empty when
+// [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is created, which
+// defaults to digital parser. The first call to
+// [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize
+// the config.
+message DocumentProcessingConfig {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/DocumentProcessingConfig"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/documentProcessingConfig"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig"
+  };
+
+  // Related configurations applied to a specific type of document parser.
+  message ParsingConfig {
+    // The digital parsing configurations for documents.
+    message DigitalParsingConfig {}
+
+    // The OCR parsing configurations for documents.
+    message OcrParsingConfig {
+      // Apply additional enhanced OCR processing to a list of document
+      // elements.
+      //
+      // Supported values:
+      // * `table`: advanced table parsing model.
+      repeated string enhanced_document_elements = 1;
+
+      // If true, will use native text instead of OCR text on pages containing
+      // native text.
+      bool use_native_text = 2;
+    }
+
+    // Configs for document processing types.
+    oneof type_dedicated_config {
+      // Configurations applied to digital parser.
+      DigitalParsingConfig digital_parsing_config = 1;
+
+      // Configurations applied to OCR parser. Currently it only applies to
+      // PDFs.
+      OcrParsingConfig ocr_parsing_config = 2;
+    }
+  }
+
+  // The full resource name of the Document Processing Config.
+  // Format:
+  // `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
+  string name = 1;
+
+  // Configurations for default Document parser.
+  // If not specified, we will configure it as default DigitalParsingConfig, and
+  // the default parsing config will be applied to all file types for Document
+  // parsing.
+  ParsingConfig default_parsing_config = 4;
+
+  // Map from file type to override the default parsing configuration based on
+  // the file type. Supported keys:
+  // * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
+  // parsing or layout parsing is supported.
+  // * `html`: Override parsing config for HTML files, only digital parsing and
+  // or layout parsing are supported.
+  // * `docx`: Override parsing config for DOCX files, only digital parsing and
+  // or layout parsing are supported.
+  map<string, ParsingConfig> parsing_config_overrides = 5;
+}