@google-cloud/discoveryengine 1.3.1 → 1.4.0

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

@@ -53,7 +53,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;
     }
 

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

@@ -0,0 +1,220 @@
+// 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/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 = "EngineProto";
+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";
+
+// Metadata that describes the training and serving parameters of an
+// [Engine][google.cloud.discoveryengine.v1beta.Engine].
+message Engine {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Engine"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/engines/{engine}"
+  };
+
+  // Configurations for a Search Engine.
+  message SearchEngineConfig {
+    // The search feature tier of this engine.
+    //
+    // Different tiers might have different
+    // pricing. To learn more, please check the pricing documentation.
+    //
+    // Defaults to
+    // [SearchTier.SEARCH_TIER_STANDARD][google.cloud.discoveryengine.v1beta.SearchTier.SEARCH_TIER_STANDARD]
+    // if not specified.
+    SearchTier search_tier = 1;
+
+    // The add-on that this search engine enables.
+    repeated SearchAddOn search_add_ons = 2;
+  }
+
+  // Configurations for a Chat Engine.
+  message ChatEngineConfig {
+    // Configurations for generating a Dialogflow agent.
+    //
+    // Note that these configurations are one-time consumed by
+    // and passed to Dialogflow service. It means they cannot be retrieved using
+    // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
+    // or
+    // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
+    // API after engine creation.
+    message AgentCreationConfig {
+      // Name of the company, organization or other entity that the agent
+      // represents. Used for knowledge connector LLM prompt and for knowledge
+      // search.
+      string business = 1;
+
+      // Required. The default language of the agent as a language tag.
+      // See [Language
+      // Support](https://cloud.google.com/dialogflow/docs/reference/language)
+      // for a list of the currently supported language codes.
+      string default_language_code = 2;
+
+      // Required. The time zone of the agent from the [time zone
+      // database](https://www.iana.org/time-zones), e.g., America/New_York,
+      // Europe/Paris.
+      string time_zone = 3 [(google.api.field_behavior) = REQUIRED];
+
+      // Agent location for Agent creation, supported values: global/us/eu.
+      // If not provided, us Engine will create Agent using us-central-1 by
+      // default; eu Engine will create Agent using eu-west-1 by default.
+      string location = 4;
+    }
+
+    // The configurationt generate the Dialogflow agent that is associated to
+    // this Engine.
+    //
+    // Note that these configurations are one-time consumed by
+    // and passed to Dialogflow service. It means they cannot be retrieved using
+    // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
+    // or
+    // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
+    // API after engine creation.
+    AgentCreationConfig agent_creation_config = 1;
+
+    // The resource name of an exist Dialogflow agent to link to this Chat
+    // Engine. Customers can either provide `agent_creation_config` to create
+    // agent or provide an agent name that links the agent with the Chat engine.
+    //
+    // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+    // ID>`.
+    //
+    // Note that the `dialogflow_agent_to_link` are one-time consumed by and
+    // passed to Dialogflow service. It means they cannot be retrieved using
+    // [EngineService.GetEngine][google.cloud.discoveryengine.v1beta.EngineService.GetEngine]
+    // or
+    // [EngineService.ListEngines][google.cloud.discoveryengine.v1beta.EngineService.ListEngines]
+    // API after engine creation. Please use
+    // [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1beta.Engine.ChatEngineMetadata.dialogflow_agent]
+    // for actual agent association after Engine is created.
+    string dialogflow_agent_to_link = 2;
+  }
+
+  // Common configurations for an Engine.
+  message CommonConfig {
+    // Immutable. The name of the company, business or entity that is associated
+    // with the engine. Setting this may help improve LLM related features.
+    string company_name = 1 [(google.api.field_behavior) = IMMUTABLE];
+  }
+
+  // Additional information of a Chat Engine.
+  // Fields in this message are output only.
+  message ChatEngineMetadata {
+    // The resource name of a Dialogflow agent, that this Chat Engine refers
+    // to.
+    //
+    // Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
+    // ID>`.
+    string dialogflow_agent = 1;
+  }
+
+  // Additional config specs that defines the behavior of the engine.
+  oneof engine_config {
+    // Configurations for the Chat Engine. Only applicable if
+    // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
+    // is
+    // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
+    ChatEngineConfig chat_engine_config = 11;
+
+    // Configurations for the Search Engine. Only applicable if
+    // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
+    // is
+    // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
+    SearchEngineConfig search_engine_config = 13;
+  }
+
+  // Engine metadata to monitor the status of the engine.
+  oneof engine_metadata {
+    // Output only. Additional information of the Chat Engine. Only applicable
+    // if
+    // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
+    // is
+    // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].
+    ChatEngineMetadata chat_engine_metadata = 12
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Immutable. The fully qualified resource name of the engine.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  //
+  // Format:
+  // `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
+  // engine should be 1-63 characters, and valid characters are
+  // /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+
+  // Required. The display name of the engine. Should be human readable. UTF-8
+  // encoded string with limit of 1024 characters.
+  string display_name = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. Timestamp the Recommendation Engine was created at.
+  google.protobuf.Timestamp create_time = 3
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Timestamp the Recommendation Engine was last updated.
+  google.protobuf.Timestamp update_time = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // The data stores associated with this engine.
+  //
+  // For
+  // [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH]
+  // and
+  // [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION]
+  // type of engines, they can only associate with at most one data store.
+  //
+  // If
+  // [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type]
+  // is
+  // [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT],
+  // multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the
+  // same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be
+  // associated here.
+  //
+  // Note that when used in
+  // [CreateEngineRequest][google.cloud.discoveryengine.v1beta.CreateEngineRequest],
+  // one DataStore id must be provided as the system will use it for necessary
+  // initializations.
+  repeated string data_store_ids = 5;
+
+  // Required. The solutions of the engine.
+  SolutionType solution_type = 6 [(google.api.field_behavior) = REQUIRED];
+
+  // The industry vertical that the engine registers.
+  // The restriction of the Engine industry vertical is based on
+  // [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: If unspecified,
+  // default to `GENERIC`. Vertical on Engine has to match vertical of the
+  // DataStore liniked to the engine.
+  IndustryVertical industry_vertical = 16;
+
+  // Common config spec that specifies the metadata of the engine.
+  CommonConfig common_config = 15;
+}