@google-cloud/discoveryengine 0.4.1 → 0.6.0

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

@@ -55,7 +55,7 @@ service RecommendationService {
 // Request message for Recommend method.
 message RecommendRequest {
   // Required. Full resource name of the format:
-  // projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*
+  // `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
   //
   // Before you can request recommendations from your model, you must create at
   // least one serving config  for it.
@@ -97,8 +97,8 @@ message RecommendRequest {
   //
   // Examples:
   //
-  //  * (filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))
-  //  * (filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))
+  //  * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))`
+  //  * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))`
   //
   // If your filter blocks all results, the API will return generic
   // (unfiltered) popular Documents. If you only want results strictly matching
@@ -106,8 +106,9 @@ message RecommendRequest {
   // [RecommendRequest.params][google.cloud.discoveryengine.v1beta.RecommendRequest.params]
   // to receive empty results instead.
   //
-  // Note that the API will never return Documents with storageStatus of
-  // "EXPIRED" or "DELETED" regardless of filter choices.
+  // Note that the API will never return
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s with
+  // `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
   string filter = 4;
 
   // Use validate only mode for this recommendation query. If set to true, a
@@ -122,22 +123,22 @@ message RecommendRequest {
   //
   // * `returnDocument`: Boolean. If set to true, the associated Document
   //    object will be returned in
-  //    [RecommendResponse.results.document][RecommendationResult.document].
+  //    [RecommendResponse.RecommendationResult.document][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.document].
   // * `returnScore`: Boolean. If set to true, the recommendation 'score'
   //    corresponding to each returned Document will be set in
-  //    [RecommendResponse.results.metadata][RecommendationResult.metadata]. The
-  //    given 'score' indicates the probability of a Document conversion given
-  //    the user's context and history.
+  //    [RecommendResponse.RecommendationResult.metadata][google.cloud.discoveryengine.v1beta.RecommendResponse.RecommendationResult.metadata].
+  //    The given 'score' indicates the probability of a Document conversion
+  //    given the user's context and history.
   // * `strictFiltering`: Boolean. True by default. If set to false, the service
   //    will return generic (unfiltered) popular Documents instead of empty if
   //    your filter blocks all recommendation results.
   // * `diversityLevel`: String. Default empty. If set to be non-empty, then
   //    it needs to be one of:
-  //    *  'no-diversity'
-  //    *  'low-diversity'
-  //    *  'medium-diversity'
-  //    *  'high-diversity'
-  //    *  'auto-diversity'
+  //     *  `no-diversity`
+  //     *  `low-diversity`
+  //     *  `medium-diversity`
+  //     *  `high-diversity`
+  //     *  `auto-diversity`
   //    This gives request-level control and adjusts recommendation results
   //    based on Document category.
   map<string, google.protobuf.Value> params = 6;

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

@@ -0,0 +1,58 @@
+// 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/protobuf/struct.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 = "SchemaProto";
+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";
+
+// Defines the structure and layout of a type of document data.
+message Schema {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Schema"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}"
+  };
+
+  // Schema representation. One of
+  // [struct_schema][google.cloud.discoveryengine.v1beta.Schema.struct_schema]
+  // or [json_schema][google.cloud.discoveryengine.v1beta.Schema.json_schema]
+  // should be provided otherwise an INVALID_ARGUMENT error is thrown.
+  oneof schema {
+    // The structured representation of the schema.
+    google.protobuf.Struct struct_schema = 2;
+
+    // The JSON representation of the schema.
+    string json_schema = 3;
+  }
+
+  // Immutable. The full resource name of the schema, in the format of
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  string name = 1 [(google.api.field_behavior) = IMMUTABLE];
+}

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

@@ -0,0 +1,259 @@
+// 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/schema.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.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 = "SchemaServiceProto";
+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 [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
+service SchemaService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Gets a [Schema][google.cloud.discoveryengine.v1beta.Schema].
+  rpc GetSchema(GetSchemaRequest) returns (Schema) {
+    option (google.api.http) = {
+      get: "/v1beta/{name=projects/*/locations/*/dataStores/*/schemas/*}"
+      additional_bindings {
+        get: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets a list of [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
+  rpc ListSchemas(ListSchemasRequest) returns (ListSchemasResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/schemas"
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Creates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
+  rpc CreateSchema(CreateSchemaRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1beta/{parent=projects/*/locations/*/dataStores/*}/schemas"
+      body: "schema"
+      additional_bindings {
+        post: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*}/schemas"
+        body: "schema"
+      }
+    };
+    option (google.api.method_signature) = "parent,schema,schema_id";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.Schema"
+      metadata_type: "google.cloud.discoveryengine.v1beta.CreateSchemaMetadata"
+    };
+  }
+
+  // Updates a [Schema][google.cloud.discoveryengine.v1beta.Schema].
+  rpc UpdateSchema(UpdateSchemaRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      patch: "/v1beta/{schema.name=projects/*/locations/*/dataStores/*/schemas/*}"
+      body: "schema"
+      additional_bindings {
+        patch: "/v1beta/{schema.name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}"
+        body: "schema"
+      }
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1beta.Schema"
+      metadata_type: "google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata"
+    };
+  }
+
+  // Deletes a [Schema][google.cloud.discoveryengine.v1beta.Schema].
+  rpc DeleteSchema(DeleteSchemaRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1beta/{name=projects/*/locations/*/dataStores/*/schemas/*}"
+      additional_bindings {
+        delete: "/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata"
+    };
+  }
+}
+
+// Request message for
+// [SchemaService.GetSchema][google.cloud.discoveryengine.v1beta.SchemaService.GetSchema]
+// method.
+message GetSchemaRequest {
+  // Required. The full resource name of the schema, in the format of
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Schema"
+    }
+  ];
+}
+
+// Request message for
+// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
+// method.
+message ListSchemasRequest {
+  // Required. The parent data store resource name, in the format of
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // The maximum number of [Schema][google.cloud.discoveryengine.v1beta.Schema]s
+  // to return. The service may return fewer than this value.
+  //
+  // If unspecified, at most 100
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema]s will be returned.
+  //
+  // The maximum value is 1000; values above 1000 will be coerced to 1000.
+  int32 page_size = 2;
+
+  // A page token, received from a previous
+  // [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to
+  // [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
+  // must match the call that provided the page token.
+  string page_token = 3;
+}
+
+// Response message for
+// [SchemaService.ListSchemas][google.cloud.discoveryengine.v1beta.SchemaService.ListSchemas]
+// method.
+message ListSchemasResponse {
+  // The [Schema][google.cloud.discoveryengine.v1beta.Schema]s.
+  repeated Schema schemas = 1;
+
+  // A token that can be sent as
+  // [ListSchemasRequest.page_token][google.cloud.discoveryengine.v1beta.ListSchemasRequest.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
+// [SchemaService.CreateSchema][google.cloud.discoveryengine.v1beta.SchemaService.CreateSchema]
+// method.
+message CreateSchemaRequest {
+  // Required. The parent data store resource name, in the format of
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
+  // create.
+  Schema schema = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The ID to use for the
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema], which will become the
+  // final component of the
+  // [Schema.name][google.cloud.discoveryengine.v1beta.Schema.name].
+  //
+  // This field should conform to
+  // [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length
+  // limit of 63 characters.
+  string schema_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for
+// [SchemaService.UpdateSchema][google.cloud.discoveryengine.v1beta.SchemaService.UpdateSchema]
+// method.
+message UpdateSchemaRequest {
+  // Required. The [Schema][google.cloud.discoveryengine.v1beta.Schema] to
+  // update.
+  Schema schema = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // If set to true, and the
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema] is not found, a new
+  // [Schema][google.cloud.discoveryengine.v1beta.Schema] will be created. In
+  // this situation, `update_mask` is ignored.
+  bool allow_missing = 3;
+}
+
+// Request message for
+// [SchemaService.DeleteSchema][google.cloud.discoveryengine.v1beta.SchemaService.DeleteSchema]
+// method.
+message DeleteSchemaRequest {
+  // Required. The full resource name of the schema, in the format of
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Schema"
+    }
+  ];
+}
+
+// Metadata for Create Schema LRO.
+message CreateSchemaMetadata {
+  // 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;
+}
+
+// Metadata for UpdateSchema LRO.
+message UpdateSchemaMetadata {
+  // 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;
+}
+
+// Metadata for DeleteSchema LRO.
+message DeleteSchemaMetadata {
+  // 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;
+}