@google-cloud/discoveryengine 1.1.0 → 1.2.0

package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_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.v1alpha;
+
+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/v1alpha/conversation.proto";
+import "google/cloud/discoveryengine/v1alpha/search_service.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/field_mask.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "ConversationalSearchServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1alpha";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
+
+// Service for conversational search.
+service ConversationalSearchService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Converses a conversation.
+  rpc ConverseConversation(ConverseConversationRequest)
+      returns (ConverseConversationResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}:converse"
+      body: "*"
+      additional_bindings {
+        post: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}:converse"
+        body: "*"
+      }
+    };
+    option (google.api.method_signature) = "name,query";
+  }
+
+  // Creates a Conversation.
+  //
+  // If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
+  // create already exists, an ALREADY_EXISTS error is returned.
+  rpc CreateConversation(CreateConversationRequest) returns (Conversation) {
+    option (google.api.http) = {
+      post: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations"
+      body: "conversation"
+      additional_bindings {
+        post: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
+        body: "conversation"
+      }
+    };
+    option (google.api.method_signature) = "parent,conversation";
+  }
+
+  // Deletes a Conversation.
+  //
+  // If the [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
+  // delete does not exist, a NOT_FOUND error is returned.
+  rpc DeleteConversation(DeleteConversationRequest)
+      returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}"
+      additional_bindings {
+        delete: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Updates a Conversation.
+  //
+  // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] action
+  // type cannot be changed. If the
+  // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to update
+  // does not exist, a NOT_FOUND error is returned.
+  rpc UpdateConversation(UpdateConversationRequest) returns (Conversation) {
+    option (google.api.http) = {
+      patch: "/v1alpha/{conversation.name=projects/*/locations/*/dataStores/*/conversations/*}"
+      body: "conversation"
+      additional_bindings {
+        patch: "/v1alpha/{conversation.name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
+        body: "conversation"
+      }
+    };
+    option (google.api.method_signature) = "conversation,update_mask";
+  }
+
+  // Gets a Conversation.
+  rpc GetConversation(GetConversationRequest) returns (Conversation) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=projects/*/locations/*/dataStores/*/conversations/*}"
+      additional_bindings {
+        get: "/v1alpha/{name=projects/*/locations/*/collections/*/dataStores/*/conversations/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all Conversations by their parent
+  // [DataStore][google.cloud.discoveryengine.v1alpha.DataStore].
+  rpc ListConversations(ListConversationsRequest)
+      returns (ListConversationsResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{parent=projects/*/locations/*/dataStores/*}/conversations"
+      additional_bindings {
+        get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/conversations"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
+}
+
+// Request message for
+// [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation]
+// method.
+message ConverseConversationRequest {
+  // Required. The resource name of the Conversation to get. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
+  // Use
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
+  // to activate auto session mode, which automatically creates a new
+  // conversation inside a ConverseConversation session.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Conversation"
+    }
+  ];
+
+  // Required. Current user input.
+  TextInput query = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // The resource name of the Serving Config to use. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+  // If this is not set, the default serving config will be used.
+  string serving_config = 3 [(google.api.resource_reference) = {
+    type: "discoveryengine.googleapis.com/ServingConfig"
+  }];
+
+  // The conversation to be used by auto session only. The name field will be
+  // ignored as we automatically assign new name for the conversation in auto
+  // session.
+  Conversation conversation = 5;
+
+  // Whether to turn on safe search.
+  bool safe_search = 6;
+
+  // The user labels applied to a resource must meet the following requirements:
+  //
+  // * Each resource can have multiple labels, up to a maximum of 64.
+  // * Each label must be a key-value pair.
+  // * Keys have a minimum length of 1 character and a maximum length of 63
+  //   characters and cannot be empty. Values can be empty and have a maximum
+  //   length of 63 characters.
+  // * Keys and values can contain only lowercase letters, numeric characters,
+  //   underscores, and dashes. All characters must use UTF-8 encoding, and
+  //   international characters are allowed.
+  // * The key portion of a label must be unique. However, you can use the same
+  //   key with multiple resources.
+  // * Keys must start with a lowercase letter or international character.
+  //
+  // See [Google Cloud
+  // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+  // for more details.
+  map<string, string> user_labels = 7;
+
+  // A specification for configuring the summary returned in the response.
+  SearchRequest.ContentSearchSpec.SummarySpec summary_spec = 8;
+}
+
+// Response message for
+// [ConversationalSearchService.ConverseConversation][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.ConverseConversation]
+// method.
+message ConverseConversationResponse {
+  // Answer to the current query.
+  Reply reply = 1;
+
+  // Updated conversation including the answer.
+  Conversation conversation = 2;
+
+  // Suggested related questions.
+  repeated string related_questions = 6;
+
+  // Search Results.
+  repeated SearchResponse.SearchResult search_results = 3;
+}
+
+// Request for CreateConversation method.
+message CreateConversationRequest {
+  // Required. Full resource name of parent data store. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Required. The conversation to create.
+  Conversation conversation = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request for UpdateConversation method.
+message UpdateConversationRequest {
+  // Required. The Conversation to update.
+  Conversation conversation = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided
+  // [Conversation][google.cloud.discoveryengine.v1alpha.Conversation] to
+  // update. The following are NOT supported:
+  //
+  // * [conversation.name][]
+  //
+  // If not set or empty, all supported fields are updated.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request for DeleteConversation method.
+message DeleteConversationRequest {
+  // Required. The resource name of the Conversation to delete. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Conversation"
+    }
+  ];
+}
+
+// Request for GetConversation method.
+message GetConversationRequest {
+  // Required. The resource name of the Conversation to get. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Conversation"
+    }
+  ];
+}
+
+// Request for ListConversations method.
+message ListConversationsRequest {
+  // Required. The data store resource name. Format:
+  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/DataStore"
+    }
+  ];
+
+  // Maximum number of results to return. If unspecified, defaults
+  // to 50. Max allowed value is 1000.
+  int32 page_size = 2;
+
+  // A page token, received from a previous `ListConversations` call.
+  // Provide this to retrieve the subsequent page.
+  string page_token = 3;
+
+  // A filter to apply on the list results. The supported features are:
+  // user_pseudo_id, state.
+  //
+  // Example:
+  // "user_pseudo_id = some_id"
+  string filter = 4;
+
+  // A comma-separated list of fields to order by, sorted in ascending order.
+  // Use "desc" after a field name for descending.
+  // Supported fields:
+  //   * `update_time`
+  //   * `create_time`
+  //   * `conversation_name`
+  //
+  // Example:
+  // "update_time desc"
+  // "create_time"
+  string order_by = 5;
+}
+
+// Response for ListConversations method.
+message ListConversationsResponse {
+  // All the Conversations for a given data store.
+  repeated Conversation conversations = 1;
+
+  // Pagination token, if not returned indicates the last page.
+  string next_page_token = 2;
+}

package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto

@@ -0,0 +1,121 @@
+// 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.v1alpha;
+
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/protobuf/struct.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1alpha/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "DocumentProto";
+option java_package = "com.google.cloud.discoveryengine.v1alpha";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1alpha";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1alpha";
+
+// Document captures all raw metadata information of items to be recommended or
+// searched.
+message Document {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Document"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}"
+  };
+
+  // Unstructured data linked to this document.
+  message Content {
+    oneof content {
+      // The content represented as a stream of bytes. The maximum length is
+      // 1,000,000 bytes (1 MB / ~0.95 MiB).
+      //
+      // Note: As with all `bytes` fields, this field is represented as pure
+      // binary in Protocol Buffers and base64-encoded string in JSON. For
+      // example, `abc123!?$*&()'-=@~` should be represented as
+      // `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See
+      // https://developers.google.com/protocol-buffers/docs/proto3#json.
+      bytes raw_bytes = 2;
+
+      // 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.
+      string uri = 3;
+    }
+
+    // The MIME type of the content. Supported types:
+    //
+    // * `application/pdf` (PDF, only native PDFs are supported for now)
+    // * `text/html` (HTML)
+    // * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+    // * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+    // * `text/plain` (TXT)
+    //
+    // See https://www.iana.org/assignments/media-types/media-types.xhtml.
+    string mime_type = 1;
+  }
+
+  // Data representation. One of
+  // [struct_data][google.cloud.discoveryengine.v1alpha.Document.struct_data] or
+  // [json_data][google.cloud.discoveryengine.v1alpha.Document.json_data] should
+  // be provided otherwise an `INVALID_ARGUMENT` error is thrown.
+  oneof data {
+    // The structured JSON data for the document. It should conform to the
+    // registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
+    google.protobuf.Struct struct_data = 4;
+
+    // The JSON string representation of the document. It should conform to the
+    // registered [Schema][google.cloud.discoveryengine.v1alpha.Schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
+    string json_data = 5;
+  }
+
+  // Immutable. The full resource name of the document.
+  // Format:
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_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];
+
+  // Immutable. The identifier of the document.
+  //
+  // Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+  // standard with a length limit of 63 characters.
+  string id = 2 [(google.api.field_behavior) = IMMUTABLE];
+
+  // The identifier of the schema located in the same data store.
+  string schema_id = 3;
+
+  // The unstructured data linked to this document. Content must be set if this
+  // document is under a
+  // `CONTENT_REQUIRED` data store.
+  Content content = 10;
+
+  // The identifier of the parent document. Currently supports at most two level
+  // document hierarchy.
+  //
+  // Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
+  // standard with a length limit of 63 characters.
+  string parent_document_id = 7;
+
+  // Output only. This field is OUTPUT_ONLY.
+  // 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];
+}