@google-cloud/discoveryengine 1.12.0 → 1.14.0

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

@@ -23,6 +23,7 @@ import "google/api/resource.proto";
 import "google/cloud/discoveryengine/v1alpha/site_search_engine.proto";
 import "google/longrunning/operations.proto";
 import "google/protobuf/empty.proto";
+import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Alpha";
@@ -221,6 +222,29 @@ service SiteSearchEngineService {
       get: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus"
     };
   }
+
+  // Sets the URI Pattern to Document data mapping for an Advanced Site Search
+  // DataStore.
+  rpc SetUriPatternDocumentData(SetUriPatternDocumentDataRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:setUriPatternDocumentData"
+      body: "*"
+    };
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse"
+      metadata_type: "google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata"
+    };
+  }
+
+  // Gets the URI Pattern to Document data mapping for an Advanced Site Search
+  // DataStore.
+  rpc GetUriPatternDocumentData(GetUriPatternDocumentDataRequest)
+      returns (GetUriPatternDocumentDataResponse) {
+    option (google.api.http) = {
+      get: "/v1alpha/{site_search_engine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:getUriPatternDocumentData"
+    };
+  }
 }
 
 // Request message for
@@ -693,3 +717,105 @@ message FetchDomainVerificationStatusResponse {
   // This will always be populated in the response.
   int32 total_size = 3;
 }
+
+// Request message for
+// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
+// method.
+message SetUriPatternDocumentDataRequest {
+  // Required. Full resource name of the
+  // [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
+  // such as
+  // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+  string site_search_engine = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    }
+  ];
+
+  // Document data keyed by URI pattern. Each entry must be consistent with
+  // the [Schema][google.cloud.discoveryengine.v1alpha.Schema]. For example:
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema] = {
+  // "type": "object",
+  // "properties": {
+  //   "Categories": {
+  //     "type": "array",
+  //     "items": {
+  //       "retrievable": true,
+  //       "type": "string"
+  //     }
+  //   }
+  // }
+  //
+  // document_data_map = {
+  //   "www.url1.com/*": {
+  //     "Categories": ["category1", "category2"]
+  //   },
+  //   "www.url2.com/*": {
+  //     "Categories": ["category3"]
+  //   }
+  // }
+  map<string, google.protobuf.Struct> document_data_map = 2;
+
+  // If true, clears the document data map. If true,
+  // [SetUriPatternDocumentDataRequest.document_data_map][google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map]
+  // must be empty.
+  bool empty_document_data_map = 4;
+
+  // Optional. If not provided, the current
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema] is used. If provided,
+  // validates and updates the
+  // [Schema][google.cloud.discoveryengine.v1alpha.Schema]. If validation fails,
+  // an error is returned.
+  google.protobuf.Struct schema = 3;
+}
+
+// Response message for
+// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
+// method.
+message SetUriPatternDocumentDataResponse {}
+
+// Metadata related to the progress of the
+// [SiteSearchEngineService.SetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.SetUriPatternDocumentData]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message SetUriPatternDocumentDataMetadata {
+  // 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
+// [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData]
+// method.
+message GetUriPatternDocumentDataRequest {
+  // Required. Full resource name of the
+  // [SiteSearchEngine][google.cloud.discoveryengine.v1alpha.SiteSearchEngine],
+  // such as
+  // `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.
+  string site_search_engine = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/SiteSearchEngine"
+    }
+  ];
+}
+
+// Response message for
+// [SiteSearchEngineService.GetUriPatternDocumentData][google.cloud.discoveryengine.v1alpha.SiteSearchEngineService.GetUriPatternDocumentData]
+// method.
+message GetUriPatternDocumentDataResponse {
+  // Document data keyed by URI pattern. For example:
+  // document_data_map = {
+  //   "www.url1.com/*": {
+  //     "Categories": ["category1", "category2"]
+  //   },
+  //   "www.url2.com/*": {
+  //     "Categories": ["category3"]
+  //   }
+  // }
+  map<string, google.protobuf.Struct> document_data_map = 1;
+}

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

@@ -458,6 +458,10 @@ message DocumentInfo {
   // The promotion IDs associated with this Document.
   // Currently, this field is restricted to at most one ID.
   repeated string promotion_ids = 4;
+
+  // Output only. Whether the referenced Document can be found in the data
+  // store.
+  bool joined = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
 
 // Detailed panel information associated with a user event.

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

@@ -68,6 +68,9 @@ service UserEventService {
       additional_bindings {
         get: "/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*}/userEvents:collect"
       }
+      additional_bindings {
+        get: "/v1alpha/{parent=projects/*/locations/*}/userEvents:collect"
+      }
     };
   }
 

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

@@ -69,6 +69,13 @@ message Answer {
 
         // Page identifier.
         string page_identifier = 2;
+
+        // The relevance of the chunk for a given query. Values range from 0.0
+        // (completely irrelevant) to 1.0 (completely relevant).
+        // This value is for informational purpose only. It may change for
+        // the same query and chunk at any time due to a model retraining or
+        // change in implementation.
+        optional float relevance_score = 3;
       }
 
       // Document resource name.
@@ -121,13 +128,28 @@ message Answer {
       // Chunk textual content.
       string content = 2;
 
-      // Relevance score.
+      // The relevance of the chunk for a given query. Values range from 0.0
+      // (completely irrelevant) to 1.0 (completely relevant).
+      // This value is for informational purpose only. It may change for
+      // the same query and chunk at any time due to a model retraining or
+      // change in implementation.
       optional float relevance_score = 3;
 
       // Document metadata.
       DocumentMetadata document_metadata = 4;
     }
 
+    // Structured search information.
+    message StructuredDocumentInfo {
+      // Document resource name.
+      string document = 1 [(google.api.resource_reference) = {
+        type: "discoveryengine.googleapis.com/Document"
+      }];
+
+      // Structured search data.
+      google.protobuf.Struct struct_data = 2;
+    }
+
     // Search result content.
     oneof content {
       // Unstructured document information.
@@ -135,6 +157,9 @@ message Answer {
 
       // Chunk information.
       ChunkInfo chunk_info = 2;
+
+      // Structured document information.
+      StructuredDocumentInfo structured_document_info = 3;
     }
   }
 
@@ -168,7 +193,11 @@ message Answer {
             // Chunk textual content.
             string content = 2;
 
-            // Relevance score.
+            // The relevance of the chunk for a given query. Values range from
+            // 0.0 (completely irrelevant) to 1.0 (completely relevant).
+            // This value is for informational purpose only. It may change for
+            // the same query and chunk at any time due to a model retraining or
+            // change in implementation.
             optional float relevance_score = 3;
           }
 
@@ -255,6 +284,9 @@ message Answer {
 
         // Non-answer-seeking query classification type.
         NON_ANSWER_SEEKING_QUERY = 2;
+
+        // Jail-breaking query classification type.
+        JAIL_BREAKING_QUERY = 3;
       }
 
       // Query classification type.
@@ -310,6 +342,19 @@ message Answer {
     // Google skips the answer if there is no relevant content in the
     // retrieved search results.
     NO_RELEVANT_CONTENT = 5;
+
+    // The jail-breaking query ignored case.
+    //
+    // For example, "Reply in the tone of a competing company's CEO".
+    // Google skips the answer if the query is classified as a jail-breaking
+    // query.
+    JAIL_BREAKING_QUERY_IGNORED = 6;
+
+    // The customer policy violation case.
+    //
+    // Google skips the summary if there is a customer policy violation
+    // detected. The policy is defined by the customer.
+    CUSTOMER_POLICY_VIOLATION = 7;
   }
 
   // Immutable. Fully qualified name

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

@@ -184,7 +184,7 @@ message Control {
   string display_name = 2 [(google.api.field_behavior) = REQUIRED];
 
   // Output only. List of all
-  // [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] ids this
+  // [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] IDs this
   // control is attached to. May take up to 10 minutes to update after changes.
   repeated string associated_serving_config_ids = 3
       [(google.api.field_behavior) = OUTPUT_ONLY];

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

@@ -706,6 +706,9 @@ message AnswerQueryRequest {
 
         // Non-answer-seeking query classification type.
         NON_ANSWER_SEEKING_QUERY = 2;
+
+        // Jail-breaking query classification type.
+        JAIL_BREAKING_QUERY = 3;
       }
 
       // Enabled query classification types.

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

@@ -59,6 +59,9 @@ message CustomTuningModel {
 
     // The model training finished successfully but metrics did not improve.
     NO_IMPROVEMENT = 6;
+
+    // Input data validation failed. Model training didn't start.
+    INPUT_VALIDATION_FAILED = 7;
   }
 
   // Required. The fully qualified resource name of the model.

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

@@ -20,6 +20,7 @@ import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/protobuf/struct.proto";
 import "google/protobuf/timestamp.proto";
+import "google/rpc/status.proto";
 
 option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1Beta";
 option go_package = "cloud.google.com/go/discoveryengine/apiv1beta/discoveryenginepb;discoveryenginepb";
@@ -70,6 +71,17 @@ message Document {
     string mime_type = 1;
   }
 
+  // Index status of the document.
+  message IndexStatus {
+    // The time when the document was indexed.
+    // If this field is populated, it means the document has been indexed.
+    google.protobuf.Timestamp index_time = 1;
+
+    // A sample of errors encountered while indexing the document.
+    // If this field is populated, the document is not indexed due to errors.
+    repeated google.rpc.Status error_samples = 2;
+  }
+
   // Data representation. One of
   // [struct_data][google.cloud.discoveryengine.v1beta.Document.struct_data] or
   // [json_data][google.cloud.discoveryengine.v1beta.Document.json_data] should
@@ -127,4 +139,12 @@ message Document {
   // document has never been indexed.
   google.protobuf.Timestamp index_time = 13
       [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The index status of the document.
+  //
+  // * If document is indexed successfully, the index_time field is populated.
+  // * Otherwise, if document is not indexed due to errors, the error_samples
+  //   field is populated.
+  // * Otherwise, index_status is unset.
+  IndexStatus index_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
 }

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

@@ -123,5 +123,7 @@ message DocumentProcessingConfig {
   // layout parsing are supported.
   // * `pptx`: Override parsing config for PPTX files, only digital parsing and
   // layout parsing are supported.
+  // * `xlsx`: Override parsing config for XLSX files, only digital parsing and
+  // layout parsing are supported.
   map<string, ParsingConfig> parsing_config_overrides = 5;
 }

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

@@ -26,6 +26,7 @@ import "google/cloud/discoveryengine/v1beta/purge_config.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";
@@ -158,6 +159,20 @@ service DocumentService {
       metadata_type: "google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata"
     };
   }
+
+  // Gets index freshness metadata for
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s. Supported for
+  // website search only.
+  rpc BatchGetDocumentsMetadata(BatchGetDocumentsMetadataRequest)
+      returns (BatchGetDocumentsMetadataResponse) {
+    option (google.api.http) = {
+      get: "/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
+      additional_bindings {
+        get: "/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/batchGetDocumentsMetadata"
+      }
+    };
+    option (google.api.method_signature) = "parent";
+  }
 }
 
 // Request message for
@@ -320,3 +335,102 @@ message DeleteDocumentRequest {
     }
   ];
 }
+
+// Request message for
+// [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata]
+// method.
+message BatchGetDocumentsMetadataRequest {
+  // Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s
+  // by exact uris.
+  message UrisMatcher {
+    // The exact URIs to match by.
+    repeated string uris = 1;
+  }
+
+  // Matcher for the [Document][google.cloud.discoveryengine.v1beta.Document]s.
+  // Currently supports matching by exact URIs.
+  message Matcher {
+    // Matcher for the
+    // [Document][google.cloud.discoveryengine.v1beta.Document]s.
+    oneof matcher {
+      // Matcher by exact URIs.
+      UrisMatcher uris_matcher = 1;
+    }
+  }
+
+  // Required. The parent branch resource name, such as
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Branch"
+    }
+  ];
+
+  // Required. Matcher for the
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s.
+  Matcher matcher = 2 [(google.api.field_behavior) = REQUIRED];
+}
+
+// Response message for
+// [DocumentService.BatchGetDocumentsMetadata][google.cloud.discoveryengine.v1beta.DocumentService.BatchGetDocumentsMetadata]
+// method.
+message BatchGetDocumentsMetadataResponse {
+  // The metadata of a [Document][google.cloud.discoveryengine.v1beta.Document].
+  message DocumentMetadata {
+    // The value of the matcher that was used to match the
+    // [Document][google.cloud.discoveryengine.v1beta.Document].
+    message MatcherValue {
+      // The value of the matcher that was used to match the
+      // [Document][google.cloud.discoveryengine.v1beta.Document].
+      oneof matcher_value {
+        // If match by URI, the URI of the
+        // [Document][google.cloud.discoveryengine.v1beta.Document].
+        string uri = 1;
+      }
+    }
+
+    // The value of the matcher that was used to match the
+    // [Document][google.cloud.discoveryengine.v1beta.Document].
+    MatcherValue matcher_value = 2;
+
+    // The state of the document.
+    State state = 3;
+
+    // The timestamp of the last time the
+    // [Document][google.cloud.discoveryengine.v1beta.Document] was last
+    // indexed.
+    google.protobuf.Timestamp last_refreshed_time = 4;
+
+    // The data ingestion source of the
+    // [Document][google.cloud.discoveryengine.v1beta.Document].
+    //
+    // Allowed values are:
+    //
+    // * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
+    // * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
+    string data_ingestion_source = 5;
+  }
+
+  // The state of the [Document][google.cloud.discoveryengine.v1beta.Document].
+  enum State {
+    // Should never be set.
+    STATE_UNSPECIFIED = 0;
+
+    // The [Document][google.cloud.discoveryengine.v1beta.Document] is indexed.
+    INDEXED = 1;
+
+    // The [Document][google.cloud.discoveryengine.v1beta.Document] is not
+    // indexed because its URI is not in the
+    // [TargetSite][google.cloud.discoveryengine.v1beta.TargetSite].
+    NOT_IN_TARGET_SITE = 2;
+
+    // The [Document][google.cloud.discoveryengine.v1beta.Document] is not
+    // indexed.
+    NOT_IN_INDEX = 3;
+  }
+
+  // The metadata of the
+  // [Document][google.cloud.discoveryengine.v1beta.Document]s.
+  repeated DocumentMetadata documents_metadata = 1;
+}

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

@@ -129,8 +129,9 @@ message CheckGroundingResponse {
     // field will be set to false. In that case, no grounding check was done for
     // the claim and therefore
     // [citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.citation_indices],
+    // [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices],
     // and
-    // [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
+    // [score][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.score]
     // should not be returned.
     optional bool grounding_check_required = 6;
   }

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

@@ -84,7 +84,7 @@ message BigQuerySource {
     google.type.Date partition_date = 5;
   }
 
-  // The project ID (can be project # or ID) that the BigQuery source is in with
+  // The project ID or the project number that contains the BigQuery source. Has
   // a length limit of 128 characters. If not specified, inherits the project
   // ID from the parent request.
   string project_id = 1;
@@ -126,7 +126,7 @@ message BigQuerySource {
 
 // The Spanner source for importing data
 message SpannerSource {
-  // The project ID that the Spanner source is in with a length limit of 128
+  // The project ID that contains the Spanner source. Has a length limit of 128
   // characters. If not specified, inherits the project ID from the parent
   // request.
   string project_id = 1;
@@ -260,7 +260,7 @@ message BigtableOptions {
 
 // The Cloud Bigtable source for importing data.
 message BigtableSource {
-  // The project ID that the Bigtable source is in with a length limit of 128
+  // The project ID that contains the Bigtable source. Has a length limit of 128
   // characters. If not specified, inherits the project ID from the parent
   // request.
   string project_id = 1;
@@ -292,12 +292,18 @@ message FhirStoreSource {
   // limit of 2,000 characters. Can be specified if one wants to have the
   // FhirStore export to a specific Cloud Storage directory.
   string gcs_staging_dir = 2;
+
+  // The FHIR resource types to import. The resource types should be a subset of
+  // all [supported FHIR resource
+  // types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification).
+  // Default to all supported FHIR resource types if empty.
+  repeated string resource_types = 3;
 }
 
 // Cloud SQL source import data from.
 message CloudSqlSource {
-  // The project ID that the Cloud SQL source is in with a length limit of 128
-  // characters. If not specified, inherits the project ID from the parent
+  // The project ID that contains the Cloud SQL source. Has a length limit of
+  // 128 characters. If not specified, inherits the project ID from the parent
   // request.
   string project_id = 1;
 
@@ -329,8 +335,8 @@ message CloudSqlSource {
 
 // AlloyDB source import data from.
 message AlloyDbSource {
-  // The project ID that the AlloyDB source is in
-  // with a length limit of 128 characters. If not specified, inherits the
+  // The project ID that contains the AlloyDB source.
+  // Has a length limit of 128 characters. If not specified, inherits the
   // project ID from the parent request.
   string project_id = 1;
 

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

@@ -18,6 +18,7 @@ package google.cloud.discoveryengine.v1beta;
 
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
+import "google/cloud/discoveryengine/v1beta/import_config.proto";
 import "google/protobuf/timestamp.proto";
 import "google/rpc/status.proto";
 
@@ -103,10 +104,50 @@ message PurgeUserEventsMetadata {
   int64 failure_count = 4;
 }
 
+// Configuration of destination for Purge related errors.
+message PurgeErrorConfig {
+  // Required. Errors destination.
+  oneof destination {
+    // Cloud Storage prefix for purge errors. This must be an empty,
+    // existing Cloud Storage directory. Purge errors are written to
+    // sharded files in this directory, one per line, as a JSON-encoded
+    // `google.rpc.Status` message.
+    string gcs_prefix = 1;
+  }
+}
+
 // Request message for
 // [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
 // method.
 message PurgeDocumentsRequest {
+  // The inline source for the input config for
+  // [DocumentService.PurgeDocuments][google.cloud.discoveryengine.v1beta.DocumentService.PurgeDocuments]
+  // method.
+  message InlineSource {
+    // Required. A list of full resource name of documents to purge. In the
+    // format
+    // `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
+    // Recommended max of 100 items.
+    repeated string documents = 1 [
+      (google.api.field_behavior) = REQUIRED,
+      (google.api.resource_reference) = {
+        type: "discoveryengine.googleapis.com/Document"
+      }
+    ];
+  }
+
+  // The desired input source for the purging documents based on document IDs.
+  oneof source {
+    // Cloud Storage location for the input content.
+    // Supported `data_schema`:
+    // * `document_id`: One valid
+    // [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
+    GcsSource gcs_source = 5;
+
+    // Inline source for the input content for purge.
+    InlineSource inline_source = 6;
+  }
+
   // Required. The parent resource name, such as
   // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
   string parent = 1 [
@@ -121,6 +162,9 @@ message PurgeDocumentsRequest {
   // `*` (all items).
   string filter = 2 [(google.api.field_behavior) = REQUIRED];
 
+  // The desired location of errors incurred during the purge.
+  PurgeErrorConfig error_config = 7;
+
   // Actually performs the purge. If `force` is set to false, return the
   // expected purge count without deleting any documents.
   bool force = 3;