@google-cloud/discoveryengine 2.2.0 → 2.4.0

package/build/protos/google/cloud/discoveryengine/v1/assistant_service.proto

@@ -0,0 +1,217 @@
+// Copyright 2025 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.v1;
+
+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/v1/assist_answer.proto";
+import "google/cloud/discoveryengine/v1/search_service.proto";
+import "google/cloud/discoveryengine/v1/session.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "AssistantServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// Service for managing Assistant configuration and assisting users.
+service AssistantService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Assists the user with a query in a streaming fashion.
+  rpc StreamAssist(StreamAssistRequest) returns (stream StreamAssistResponse) {
+    option (google.api.http) = {
+      post: "/v1/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist"
+      body: "*"
+    };
+  }
+}
+
+// User metadata of the request.
+message AssistUserMetadata {
+  // Optional. IANA time zone, e.g. Europe/Budapest.
+  string time_zone = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Preferred language to be used for answering if language detection
+  // fails. Also used as the language of error messages created by actions,
+  // regardless of language detection results.
+  string preferred_language_code = 2 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Request for the
+// [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
+// method.
+message StreamAssistRequest {
+  // Specification of tools that are used to serve the request.
+  message ToolsSpec {
+    // Specification of the Vertex AI Search tool.
+    message VertexAiSearchSpec {
+      // Optional. Specs defining
+      // [DataStore][google.cloud.discoveryengine.v1.DataStore]s to filter on in
+      // a search call and configurations for those data stores. This is only
+      // considered for [Engine][google.cloud.discoveryengine.v1.Engine]s with
+      // multiple data stores.
+      repeated SearchRequest.DataStoreSpec data_store_specs = 2
+          [(google.api.field_behavior) = OPTIONAL];
+
+      // Optional. The filter syntax consists of an expression language for
+      // constructing a predicate from one or more fields of the documents being
+      // filtered. Filter expression is case-sensitive.
+      //
+      // If this field is unrecognizable, an  `INVALID_ARGUMENT`  is returned.
+      //
+      // Filtering in Vertex AI Search is done by mapping the LHS filter key to
+      // a key property defined in the Vertex AI Search backend -- this mapping
+      // is defined by the customer in their schema. For example a media
+      // customer might have a field 'name' in their schema. In this case the
+      // filter would look like this: filter --> name:'ANY("king kong")'
+      //
+      // For more information about filtering including syntax and filter
+      // operators, see
+      // [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      string filter = 4 [(google.api.field_behavior) = OPTIONAL];
+    }
+
+    // Specification of the web grounding tool.
+    message WebGroundingSpec {}
+
+    // Specification of the image generation tool.
+    message ImageGenerationSpec {}
+
+    // Specification of the video generation tool.
+    message VideoGenerationSpec {}
+
+    // Optional. Specification of the Vertex AI Search tool.
+    VertexAiSearchSpec vertex_ai_search_spec = 1
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Specification of the web grounding tool.
+    // If field is present, enables grounding with web search. Works only if
+    // [Assistant.web_grounding_type][google.cloud.discoveryengine.v1.Assistant.web_grounding_type]
+    // is [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] or
+    // [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][].
+    WebGroundingSpec web_grounding_spec = 2
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Specification of the image generation tool.
+    ImageGenerationSpec image_generation_spec = 3
+        [(google.api.field_behavior) = OPTIONAL];
+
+    // Optional. Specification of the video generation tool.
+    VideoGenerationSpec video_generation_spec = 4
+        [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Assistant generation specification for the request.
+  // This allows to override the default generation configuration at the engine
+  // level.
+  message GenerationSpec {
+    // Optional. The Vertex AI model_id used for the generative model. If not
+    // set, the default Assistant model will be used.
+    string model_id = 1 [(google.api.field_behavior) = OPTIONAL];
+  }
+
+  // Required. The resource name of the
+  // [Assistant][google.cloud.discoveryengine.v1.Assistant]. Format:
+  // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}`
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Assistant"
+    }
+  ];
+
+  // Optional. Current user query.
+  //
+  // Empty query is only supported if `file_ids` are provided. In this case, the
+  // answer will be generated based on those context files.
+  Query query = 2 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. The session to use for the request. If specified, the assistant
+  // has access to the session history, and the query and the answer are stored
+  // there.
+  //
+  // If `-` is specified as the session ID, or it is left empty, then a new
+  // session is created with an automatically generated ID.
+  //
+  // Format:
+  // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`
+  string session = 3 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Session"
+    }
+  ];
+
+  // Optional. Information about the user initiating the query.
+  AssistUserMetadata user_metadata = 6 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specification of tools that are used to serve the request.
+  ToolsSpec tools_spec = 18 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Specification of the generation configuration for the request.
+  GenerationSpec generation_spec = 19 [(google.api.field_behavior) = OPTIONAL];
+}
+
+// Response for the
+// [AssistantService.StreamAssist][google.cloud.discoveryengine.v1.AssistantService.StreamAssist]
+// method.
+message StreamAssistResponse {
+  // Information about the session.
+  message SessionInfo {
+    // Name of the newly generated or continued session.
+    //
+    // Format:
+    // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`.
+    string session = 1 [(google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Session"
+    }];
+  }
+
+  // Assist answer resource object containing parts of the assistant's final
+  // answer for the user's query.
+  //
+  // Not present if the current response doesn't add anything to previously
+  // sent
+  // [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies].
+  //
+  // Observe
+  // [AssistAnswer.state][google.cloud.discoveryengine.v1.AssistAnswer.state] to
+  // see if more parts are to be expected. While the state is `IN_PROGRESS`, the
+  // [AssistAnswer.replies][google.cloud.discoveryengine.v1.AssistAnswer.replies]
+  // field in each response will contain replies (reply fragments) to be
+  // appended to the ones received in previous responses. [AssistAnswer.name][]
+  // won't be filled.
+  //
+  // If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response
+  // is the last response and [AssistAnswer.name][] will have a value.
+  AssistAnswer answer = 1;
+
+  // Session information.
+  SessionInfo session_info = 2;
+
+  // A global unique ID that identifies the current pair of request and stream
+  // of responses. Used for feedback and support.
+  string assist_token = 4;
+}

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

@@ -82,6 +82,42 @@ message Chunk {
     repeated Chunk next_chunks = 2;
   }
 
+  // The structured content information.
+  message StructuredContent {
+    // Output only. The structure type of the structured content.
+    StructureType structure_type = 1
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. The content of the structured content.
+    string content = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // The annotation metadata includes structured content in the current chunk.
+  message AnnotationMetadata {
+    // Output only. The structured content information.
+    StructuredContent structured_content = 1
+        [(google.api.field_behavior) = OUTPUT_ONLY];
+
+    // Output only. Image id is provided if the structured content is based on
+    // an image.
+    string image_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+  }
+
+  // Defines the types of the structured content that can be extracted.
+  enum StructureType {
+    // Default value.
+    STRUCTURE_TYPE_UNSPECIFIED = 0;
+
+    // Shareholder structure.
+    SHAREHOLDER_STRUCTURE = 1;
+
+    // Signature structure.
+    SIGNATURE_STRUCTURE = 2;
+
+    // Checkbox structure.
+    CHECKBOX_STRUCTURE = 3;
+  }
+
   // 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}`.
@@ -117,4 +153,20 @@ message Chunk {
 
   // Output only. Metadata of the current chunk.
   ChunkMetadata chunk_metadata = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Image Data URLs if the current chunk contains images.
+  // Data URLs are composed of four parts: a prefix (data:), a MIME type
+  // indicating the type of data, an optional base64 token if non-textual,
+  // and the data itself:
+  // data:[<mediatype>][;base64],<data>
+  repeated string data_urls = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Annotation contents if the current chunk contains annotations.
+  repeated string annotation_contents = 11
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The annotation metadata includes structured content in the
+  // current chunk.
+  repeated AnnotationMetadata annotation_metadata = 12
+      [(google.api.field_behavior) = OUTPUT_ONLY];
 }

package/build/protos/google/cloud/discoveryengine/v1/cmek_config_service.proto

@@ -0,0 +1,300 @@
+// Copyright 2025 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.v1;
+
+import "google/api/annotations.proto";
+import "google/api/client.proto";
+import "google/api/field_behavior.proto";
+import "google/api/resource.proto";
+import "google/longrunning/operations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.DiscoveryEngine.V1";
+option go_package = "cloud.google.com/go/discoveryengine/apiv1/discoveryenginepb;discoveryenginepb";
+option java_multiple_files = true;
+option java_outer_classname = "CmekConfigServiceProto";
+option java_package = "com.google.cloud.discoveryengine.v1";
+option objc_class_prefix = "DISCOVERYENGINE";
+option php_namespace = "Google\\Cloud\\DiscoveryEngine\\V1";
+option ruby_package = "Google::Cloud::DiscoveryEngine::V1";
+
+// Service for managing CMEK related tasks
+service CmekConfigService {
+  option (google.api.default_host) = "discoveryengine.googleapis.com";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
+
+  // Provisions a CMEK key for use in a location of a customer's project.
+  // This method will also conduct location validation on the provided
+  // cmekConfig to make sure the key is valid and can be used in the
+  // selected location.
+  rpc UpdateCmekConfig(UpdateCmekConfigRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      patch: "/v1/{config.name=projects/*/locations/*/cmekConfig}"
+      body: "config"
+      additional_bindings {
+        patch: "/v1/{config.name=projects/*/locations/*/cmekConfigs/*}"
+        body: "config"
+      }
+    };
+    option (google.api.method_signature) = "config";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.cloud.discoveryengine.v1.CmekConfig"
+      metadata_type: "google.cloud.discoveryengine.v1.UpdateCmekConfigMetadata"
+    };
+  }
+
+  // Gets the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig].
+  rpc GetCmekConfig(GetCmekConfigRequest) returns (CmekConfig) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/cmekConfig}"
+      additional_bindings {
+        get: "/v1/{name=projects/*/locations/*/cmekConfigs/*}"
+      }
+    };
+    option (google.api.method_signature) = "name";
+  }
+
+  // Lists all the [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s
+  // with the project.
+  rpc ListCmekConfigs(ListCmekConfigsRequest)
+      returns (ListCmekConfigsResponse) {
+    option (google.api.http) = {
+      get: "/v1/{parent=projects/*/locations/*}/cmekConfigs"
+    };
+    option (google.api.method_signature) = "parent";
+  }
+
+  // De-provisions a CmekConfig.
+  rpc DeleteCmekConfig(DeleteCmekConfigRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      delete: "/v1/{name=projects/*/locations/*/cmekConfigs/*}"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "google.protobuf.Empty"
+      metadata_type: "google.cloud.discoveryengine.v1.DeleteCmekConfigMetadata"
+    };
+  }
+}
+
+// Request message for UpdateCmekConfig method.
+// rpc.
+message UpdateCmekConfigRequest {
+  // Required. The CmekConfig resource.
+  CmekConfig config = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Set the following CmekConfig as the default to be used for child
+  // resources if one is not specified.
+  bool set_default = 2;
+}
+
+// Request message for GetCmekConfigRequest method.
+message GetCmekConfigRequest {
+  // Required. Resource name of
+  // [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], such as
+  // `projects/*/locations/*/cmekConfig` or
+  // `projects/*/locations/*/cmekConfigs/*`.
+  //
+  // If the caller does not have permission to access the
+  // [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig], regardless of
+  // whether or not it exists, a PERMISSION_DENIED error is returned.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/CmekConfig"
+    }
+  ];
+}
+
+// Metadata for single-regional CMEKs.
+message SingleRegionKey {
+  // Required. Single-regional kms key resource name which will be used to
+  // encrypt resources
+  // `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  string kms_key = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/CryptoKeys"
+    }
+  ];
+}
+
+// Configurations used to enable CMEK data encryption with Cloud KMS keys.
+message CmekConfig {
+  option (google.api.resource) = {
+    type: "discoveryengine.googleapis.com/CmekConfig"
+    pattern: "projects/{project}/locations/{location}/cmekConfig"
+    pattern: "projects/{project}/locations/{location}/cmekConfigs/{cmek_config}"
+    plural: "cmekConfigs"
+    singular: "cmekConfig"
+  };
+
+  // States of the CmekConfig.
+  enum State {
+    // The CmekConfig state is unknown.
+    STATE_UNSPECIFIED = 0;
+
+    // The CmekConfig is creating.
+    CREATING = 1;
+
+    // The CmekConfig can be used with DataStores.
+    ACTIVE = 2;
+
+    // The CmekConfig is unavailable, most likely due to the KMS Key being
+    // revoked.
+    KEY_ISSUE = 3;
+
+    // The CmekConfig is deleting.
+    DELETING = 4;
+
+    // The CmekConfig deletion process failed.
+    DELETE_FAILED = 7;
+
+    // The CmekConfig is not usable, most likely due to some internal issue.
+    UNUSABLE = 5;
+
+    // The KMS key version is being rotated.
+    ACTIVE_ROTATING = 6;
+
+    // The KMS key is soft deleted. Some cleanup policy will eventually be
+    // applied.
+    DELETED = 8;
+  }
+
+  // States of NotebookLM.
+  enum NotebookLMState {
+    // The NotebookLM state is unknown.
+    NOTEBOOK_LM_STATE_UNSPECIFIED = 0;
+
+    // The NotebookLM is not ready.
+    NOTEBOOK_LM_NOT_READY = 1;
+
+    // The NotebookLM is ready to be used.
+    NOTEBOOK_LM_READY = 2;
+
+    // The NotebookLM is not enabled.
+    NOTEBOOK_LM_NOT_ENABLED = 3;
+  }
+
+  // Required. The name of the CmekConfig of the form
+  // `projects/{project}/locations/{location}/cmekConfig` or
+  // `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
+  string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // KMS key resource name which will be used to encrypt resources
+  // `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`.
+  string kms_key = 2 [(google.api.resource_reference) = {
+    type: "cloudkms.googleapis.com/CryptoKeys"
+  }];
+
+  // KMS key version resource name which will be used to encrypt resources
+  // `<kms_key>/cryptoKeyVersions/{keyVersion}`.
+  string kms_key_version = 6 [(google.api.resource_reference) = {
+    type: "cloudkms.googleapis.com/CryptoKeyVersions"
+  }];
+
+  // Output only. The states of the CmekConfig.
+  State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The default CmekConfig for the Customer.
+  bool is_default = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The timestamp of the last key rotation.
+  int64 last_rotation_timestamp_micros = 5
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Optional. Single-regional CMEKs that are required for some VAIS features.
+  repeated SingleRegionKey single_region_keys = 7
+      [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. Whether the NotebookLM Corpus is ready to be used.
+  NotebookLMState notebooklm_state = 8
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Metadata related to the progress of the
+// [CmekConfigService.UpdateCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.UpdateCmekConfig]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message UpdateCmekConfigMetadata {
+  // 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
+// [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs]
+// method.
+message ListCmekConfigsRequest {
+  // Required. The parent location resource name, such as
+  // `projects/{project}/locations/{location}`.
+  //
+  // If the caller does not have permission to list
+  // [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s under this
+  // location, regardless of whether or not a CmekConfig exists, a
+  // PERMISSION_DENIED error is returned.
+  string parent = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Location"
+    }
+  ];
+}
+
+// Response message for
+// [CmekConfigService.ListCmekConfigs][google.cloud.discoveryengine.v1.CmekConfigService.ListCmekConfigs]
+// method.
+message ListCmekConfigsResponse {
+  // All the customer's
+  // [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig]s.
+  repeated CmekConfig cmek_configs = 1;
+}
+
+// Request message for
+// [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig]
+// method.
+message DeleteCmekConfigRequest {
+  // Required. The resource name of the
+  // [CmekConfig][google.cloud.discoveryengine.v1.CmekConfig] to delete, such as
+  // `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/CmekConfig"
+    }
+  ];
+}
+
+// Metadata related to the progress of the
+// [CmekConfigService.DeleteCmekConfig][google.cloud.discoveryengine.v1.CmekConfigService.DeleteCmekConfig]
+// operation. This will be returned by the google.longrunning.Operation.metadata
+// field.
+message DeleteCmekConfigMetadata {
+  // 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/v1/common.proto

@@ -48,6 +48,14 @@ option (google.api.resource_definition) = {
   type: "discoveryengine.googleapis.com/RankingConfig"
   pattern: "projects/{project}/locations/{location}/rankingConfigs/{ranking_config}"
 };
+option (google.api.resource_definition) = {
+  type: "discoveryengine.googleapis.com/LicenseConfig"
+  pattern: "projects/{project}/locations/{location}/licenseConfigs/{license_config}"
+};
+option (google.api.resource_definition) = {
+  type: "discoveryengine.googleapis.com/UserStore"
+  pattern: "projects/{project}/locations/{location}/userStores/{user_store}"
+};
 option (google.api.resource_definition) = {
   type: "healthcare.googleapis.com/FhirStore"
   pattern: "projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}"
@@ -56,6 +64,14 @@ option (google.api.resource_definition) = {
   type: "healthcare.googleapis.com/FhirResource"
   pattern: "projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}"
 };
+option (google.api.resource_definition) = {
+  type: "cloudkms.googleapis.com/CryptoKeys"
+  pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}"
+};
+option (google.api.resource_definition) = {
+  type: "cloudkms.googleapis.com/CryptoKeyVersions"
+  pattern: "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}"
+};
 
 // The industry vertical associated with the
 // [DataStore][google.cloud.discoveryengine.v1.DataStore].
@@ -226,6 +242,47 @@ message DoubleList {
   repeated double values = 1;
 }
 
+// Principal identifier of a user or a group.
+message Principal {
+  // Union field principal. Principal can be a user or a group.
+  oneof principal {
+    // User identifier.
+    // For Google Workspace user account, user_id should be the google workspace
+    // user email.
+    // For non-google identity provider user account, user_id is the mapped user
+    // identifier configured during the workforcepool config.
+    string user_id = 1;
+
+    // Group identifier.
+    // For Google Workspace user account, group_id should be the google
+    // workspace group email.
+    // For non-google identity provider user account, group_id is the mapped
+    // group identifier configured during the workforcepool config.
+    string group_id = 2;
+
+    // For 3P application identities which are not present in the customer
+    // identity provider.
+    string external_entity_id = 3;
+  }
+}
+
+// Config to data store for `HEALTHCARE_FHIR` vertical.
+message HealthcareFhirConfig {
+  // Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical.
+  //
+  // If set to `true`, the predefined healthcare fhir schema can be extended
+  // for more customized searching and filtering.
+  bool enable_configurable_schema = 1;
+
+  // Whether to enable static indexing for `HEALTHCARE_FHIR` batch
+  // ingestion.
+  //
+  // If set to `true`, the batch ingestion will be processed in a static
+  // indexing mode which is slower but more capable of handling larger
+  // volume.
+  bool enable_static_indexing_for_batch_ingestion = 2;
+}
+
 // Promotion proto includes uri and other helping information to display the
 // promotion.
 message SearchLinkPromotion {
@@ -237,6 +294,16 @@ message SearchLinkPromotion {
   // site search. For other verticals, this is optional.
   string uri = 2 [(google.api.field_behavior) = OPTIONAL];
 
+  // Optional. The [Document][google.cloud.discoveryengine.v1.Document] the user
+  // wants to promote. For site search, leave unset and only populate uri. Can
+  // be set along with uri.
+  string document = 6 [
+    (google.api.field_behavior) = OPTIONAL,
+    (google.api.resource_reference) = {
+      type: "discoveryengine.googleapis.com/Document"
+    }
+  ];
+
   // Optional. The promotion thumbnail image url.
   string image_uri = 3 [(google.api.field_behavior) = OPTIONAL];