@google-cloud/discoveryengine 1.10.0 → 1.11.0

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

@@ -0,0 +1,258 @@
+// Copyright 2024 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/sample_query_set.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 = "SampleQuerySetServiceProto";
+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 managing
+// [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s,
+service SampleQuerySetService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Gets a
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
+  rpc GetSampleQuerySet(GetSampleQuerySetRequest) returns (SampleQuerySet) {
+    option (google.api.http) = {
+      get: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Gets a list of
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
+  rpc ListSampleQuerySets(ListSampleQuerySetsRequest)
+      returns (ListSampleQuerySetsResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{parent=projects/*/locations/*}/sampleQuerySets"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // Creates a
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]
+  rpc CreateSampleQuerySet(CreateSampleQuerySetRequest)
+      returns (SampleQuerySet) {
+    option (google.api.http) = {
+      post: "/v1alpha/{parent=projects/*/locations/*}/sampleQuerySets"
+      body: "sample_query_set"
+    };
+    option (google.api.method_signature) =
+        "parent,sample_query_set,sample_query_set_id";
+  }
+
+  // Updates a
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
+  rpc UpdateSampleQuerySet(UpdateSampleQuerySetRequest)
+      returns (SampleQuerySet) {
+    option (google.api.http) = {
+      patch: "/v1alpha/{sample_query_set.name=projects/*/locations/*/sampleQuerySets/*}"
+      body: "sample_query_set"
+    };
+    option (google.api.method_signature) = "sample_query_set,update_mask";
+  }
+
+  // Deletes a
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet].
+  rpc DeleteSampleQuerySet(DeleteSampleQuerySetRequest)
+      returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      delete: "/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*}"
+    };
+    option (google.api.method_signature) = "name";
+  }
+}
+
+// Request message for
+// [SampleQuerySetService.GetSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.GetSampleQuerySet]
+// method.
+message GetSampleQuerySetRequest {
+  // Required. Full resource name of
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
+  // as
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
+  //
+  // If the caller does not have permission to access the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
+  // regardless of whether or not it exists, a PERMISSION_DENIED error is
+  // returned.
+  //
+  // If the requested
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] 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/SampleQuerySet"
+    }
+  ];
+}
+
+// Request message for
+// [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
+// method.
+message ListSampleQuerySetsRequest {
+  // Required. The parent location resource name, such as
+  // `projects/{project}/locations/{location}`.
+  //
+  // If the caller does not have permission to list
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s
+  // under this location, regardless of whether or not this location exists, a
+  // `PERMISSION_DENIED` error is returned.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Location"
+    }
+  ];
+
+  // Maximum number of
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s to
+  // return. If unspecified, defaults to 100. The maximum allowed value is 1000.
+  // Values above 1000 will be coerced to 1000.
+  //
+  // If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  int32 page_size = 2;
+
+  // A page token
+  // [ListSampleQuerySetsResponse.next_page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsResponse.next_page_token],
+  // received from a previous
+  // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
+  // call. Provide this to retrieve the subsequent page.
+  //
+  // When paginating, all other parameters provided to
+  // [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
+  // must match the call that provided the page token. Otherwise, an
+  // `INVALID_ARGUMENT` error is returned.
+  string page_token = 3;
+}
+
+// Response message for
+// [SampleQuerySetService.ListSampleQuerySets][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.ListSampleQuerySets]
+// method.
+message ListSampleQuerySetsResponse {
+  // The [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s.
+  repeated SampleQuerySet sample_query_sets = 1;
+
+  // A token that can be sent as
+  // [ListSampleQuerySetsRequest.page_token][google.cloud.discoveryengine.v1alpha.ListSampleQuerySetsRequest.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
+// [SampleQuerySetService.CreateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.CreateSampleQuerySet]
+// method.
+message CreateSampleQuerySetRequest {
+  // Required. The parent resource name, such as
+  // `projects/{project}/locations/{location}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Location"
+    }
+  ];
+
+  // Required. The
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
+  // create.
+  SampleQuerySet sample_query_set = 2 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The ID to use for the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
+  // which will become the final component of the
+  // [SampleQuerySet.name][google.cloud.discoveryengine.v1alpha.SampleQuerySet.name].
+  //
+  // If the caller does not have permission to create the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
+  // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+  // returned.
+  //
+  // This field must be unique among all
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet]s with
+  // the same
+  // [parent][google.cloud.discoveryengine.v1alpha.CreateSampleQuerySetRequest.parent].
+  // Otherwise, an `ALREADY_EXISTS` error is returned.
+  //
+  // 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 sample_query_set_id = 3 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Request message for
+// [SampleQuerySetService.UpdateSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.UpdateSampleQuerySet]
+// method.
+message UpdateSampleQuerySetRequest {
+  // Required. The sample query set to update.
+  //
+  // If the caller does not have permission to update the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
+  // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+  // returned.
+  //
+  // If the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] to
+  // update does not exist a `NOT_FOUND` error is returned.
+  SampleQuerySet sample_query_set = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Indicates which fields in the provided imported 'sample query set' to
+  // update. If not set, will by default update all fields.
+  google.protobuf.FieldMask update_mask = 2;
+}
+
+// Request message for
+// [SampleQuerySetService.DeleteSampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySetService.DeleteSampleQuerySet]
+// method.
+message DeleteSampleQuerySetRequest {
+  // Required. Full resource name of
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet], such
+  // as
+  // `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
+  //
+  // If the caller does not have permission to delete the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet],
+  // regardless of whether or not it exists, a `PERMISSION_DENIED` error is
+  // returned.
+  //
+  // If the
+  // [SampleQuerySet][google.cloud.discoveryengine.v1alpha.SampleQuerySet] 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/SampleQuerySet"
+    }
+  ];
+}

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

@@ -0,0 +1,119 @@
+// Copyright 2024 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 = "ChunkProto";
+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";
+
+// Chunk captures all raw metadata information of items to be recommended or
+// searched in the chunk mode.
+message Chunk {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/Chunk"
+    pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
+    pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
+  };
+
+  // Document metadata contains the information of the document of the current
+  // chunk.
+  message DocumentMetadata {
+    // Uri of the document.
+    string uri = 1;
+
+    // Title of the document.
+    string title = 2;
+
+    // Data representation.
+    // The structured JSON data for the document. It should conform to the
+    // registered [Schema][google.cloud.discoveryengine.v1beta.Schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
+    google.protobuf.Struct struct_data = 3;
+  }
+
+  // Page span of the chunk.
+  message PageSpan {
+    // The start page of the chunk.
+    int32 page_start = 1;
+
+    // The end page of the chunk.
+    int32 page_end = 2;
+  }
+
+  // Metadata of the current chunk. This field is only populated on
+  // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
+  // API.
+  message ChunkMetadata {
+    // The previous chunks of the current chunk. The number is controlled by
+    // [SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_previous_chunks].
+    // This field is only populated on
+    // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
+    // API.
+    repeated Chunk previous_chunks = 1;
+
+    // The next chunks of the current chunk. The number is controlled by
+    // [SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks][google.cloud.discoveryengine.v1beta.SearchRequest.ContentSearchSpec.ChunkSpec.num_next_chunks].
+    // This field is only populated on
+    // [SearchService.Search][google.cloud.discoveryengine.v1beta.SearchService.Search]
+    // API.
+    repeated Chunk next_chunks = 2;
+  }
+
+  // The full resource name of the chunk.
+  // Format:
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}`.
+  //
+  // This field must be a UTF-8 encoded string with a length limit of 1024
+  // characters.
+  string name = 1;
+
+  // Unique chunk ID of the current chunk.
+  string id = 2;
+
+  // Content is a string from a document (parsed content).
+  string content = 3;
+
+  // Output only. Represents the relevance score based on similarity.
+  // Higher score indicates higher chunk relevance.
+  // The score is in range [-1.0, 1.0].
+  // Only populated on [SearchService.SearchResponse][].
+  optional double relevance_score = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Metadata of the document from the current chunk.
+  DocumentMetadata document_metadata = 5;
+
+  // 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 = 4
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Page span of the chunk.
+  PageSpan page_span = 6;
+
+  // Output only. Metadata of the current chunk.
+  ChunkMetadata chunk_metadata = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

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

@@ -51,11 +51,6 @@ option (google.api.resource_definition) = {
   type: "healthcare.googleapis.com/FhirStore"
   pattern: "projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}"
 };
-option (google.api.resource_definition) = {
-  type: "discoveryengine.googleapis.com/Chunk"
-  pattern: "projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
-  pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}"
-};
 
 // The industry vertical associated with the
 // [DataStore][google.cloud.discoveryengine.v1beta.DataStore].

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

@@ -587,6 +587,12 @@ message AnswerQueryRequest {
       // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
       string order_by = 4;
 
+      // Specifies the search result mode. If unspecified, the
+      // search result mode defaults to `DOCUMENTS`.
+      // See [parse and chunk
+      // documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)
+      SearchRequest.ContentSearchSpec.SearchResultMode search_result_mode = 5;
+
       // Specs defining dataStores to filter on in a search call and
       // configurations for those dataStores. This is only considered for
       // engines with multiple dataStores use case. For single dataStore within
@@ -793,8 +799,10 @@ message AnswerQueryRequest {
 // method.
 message AnswerQueryResponse {
   // Answer resource object.
-  // If [AnswerQueryRequest.StepSpec.max_step_count][] is greater than 1,
-  // use [Answer.name][google.cloud.discoveryengine.v1beta.Answer.name] to fetch
+  // If
+  // [AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps][google.cloud.discoveryengine.v1beta.AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps]
+  // is greater than 1, use
+  // [Answer.name][google.cloud.discoveryengine.v1beta.Answer.name] to fetch
   // answer information using
   // [ConversationalSearchService.GetAnswer][google.cloud.discoveryengine.v1beta.ConversationalSearchService.GetAnswer]
   // API.

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

@@ -54,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 2.5 MB for text-based formats, 100 MB for other formats.
+      // is 2.5 MB for text-based formats, 200 MB for other formats.
       string uri = 3;
     }
 

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

@@ -41,6 +41,30 @@ message DocumentProcessingConfig {
     pattern: "projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/documentProcessingConfig"
   };
 
+  // Configuration for chunking config.
+  message ChunkingConfig {
+    // Configuration for the layout based chunking.
+    message LayoutBasedChunkingConfig {
+      // The token size limit for each chunk.
+      //
+      // Supported values: 100-500 (inclusive).
+      // Default value: 500.
+      int32 chunk_size = 1;
+
+      // Whether to include appending different levels of headings to chunks
+      // from the middle of the document to prevent context loss.
+      //
+      // Default value: False.
+      bool include_ancestor_headings = 2;
+    }
+
+    // Additional configs that defines the behavior of the chunking.
+    oneof chunk_mode {
+      // Configuration for the layout based chunking.
+      LayoutBasedChunkingConfig layout_based_chunking_config = 1;
+    }
+  }
+
   // Related configurations applied to a specific type of document parser.
   message ParsingConfig {
     // The digital parsing configurations for documents.
@@ -57,6 +81,9 @@ message DocumentProcessingConfig {
       bool use_native_text = 2;
     }
 
+    // The layout parsing configurations for documents.
+    message LayoutParsingConfig {}
+
     // Configs for document processing types.
     oneof type_dedicated_config {
       // Configurations applied to digital parser.
@@ -65,6 +92,9 @@ message DocumentProcessingConfig {
       // Configurations applied to OCR parser. Currently it only applies to
       // PDFs.
       OcrParsingConfig ocr_parsing_config = 2;
+
+      // Configurations applied to layout parser.
+      LayoutParsingConfig layout_parsing_config = 3;
     }
   }
 
@@ -73,6 +103,9 @@ message DocumentProcessingConfig {
   // `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.
   string name = 1;
 
+  // Whether chunking mode is enabled.
+  ChunkingConfig chunking_config = 3;
+
   // 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
@@ -85,8 +118,10 @@ message DocumentProcessingConfig {
   // * `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.
+  // layout parsing are supported.
   // * `docx`: Override parsing config for DOCX files, only digital parsing and
-  // or layout parsing are supported.
+  // layout parsing are supported.
+  // * `pptx`: Override parsing config for PPTX files, only digital parsing and
+  // layout parsing are supported.
   map<string, ParsingConfig> parsing_config_overrides = 5;
 }