@google-cloud/discoveryengine 2.0.1 → 2.2.0

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

@@ -110,7 +110,7 @@ message DataStore {
   repeated SolutionType solution_types = 5;
 
   // Output only. The id of the default
-  // [Schema][google.cloud.discoveryengine.v1.Schema] asscociated to this data
+  // [Schema][google.cloud.discoveryengine.v1.Schema] associated to this data
   // store.
   string default_schema_id = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
 
@@ -124,6 +124,10 @@ message DataStore {
   google.protobuf.Timestamp create_time = 4
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Optional. Configuration for advanced site search.
+  AdvancedSiteSearchConfig advanced_site_search_config = 12
+      [(google.api.field_behavior) = OPTIONAL];
+
   // Output only. Data size estimation for billing.
   BillingEstimation billing_estimation = 23
       [(google.api.field_behavior) = OUTPUT_ONLY];
@@ -142,9 +146,12 @@ message DataStore {
   // [DataStore][google.cloud.discoveryengine.v1.DataStore] when provisioning
   // it. If unset, a default vertical specialized schema will be used.
   //
-  // This field is only used by [CreateDataStore][] API, and will be ignored if
-  // used in other APIs. This field will be omitted from all API responses
-  // including [CreateDataStore][] API. To retrieve a schema of a
+  // This field is only used by
+  // [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore]
+  // API, and will be ignored if used in other APIs. This field will be omitted
+  // from all API responses including
+  // [CreateDataStore][google.cloud.discoveryengine.v1.DataStoreService.CreateDataStore]
+  // API. To retrieve a schema of a
   // [DataStore][google.cloud.discoveryengine.v1.DataStore], use
   // [SchemaService.GetSchema][google.cloud.discoveryengine.v1.SchemaService.GetSchema]
   // API instead.
@@ -155,6 +162,15 @@ message DataStore {
   Schema starting_schema = 28;
 }
 
+// Configuration data for advance site search.
+message AdvancedSiteSearchConfig {
+  // If set true, initial indexing is disabled for the DataStore.
+  optional bool disable_initial_index = 3;
+
+  // If set true, automatic refresh is disabled for the DataStore.
+  optional bool disable_automatic_refresh = 4;
+}
+
 // Config to store data store type configuration for workspace data
 message WorkspaceConfig {
   // Specifies the type of Workspace App supported by this DataStore
@@ -182,6 +198,9 @@ message WorkspaceConfig {
 
     // Workspace Data Store contains Keep data
     GOOGLE_KEEP = 7;
+
+    // Workspace Data Store contains People data
+    GOOGLE_PEOPLE = 8;
   }
 
   // The Google Workspace data source.

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

@@ -80,6 +80,10 @@ message Document {
     // 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;
+
+    // Immutable. The message indicates the document index is in progress.
+    // If this field is populated, the document index is pending.
+    string pending_message = 3 [(google.api.field_behavior) = IMMUTABLE];
   }
 
   // Data representation. One of
@@ -109,7 +113,7 @@ message Document {
   // 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.
+  // standard with a length limit of 128 characters.
   string id = 2 [(google.api.field_behavior) = IMMUTABLE];
 
   // The identifier of the schema located in the same data store.
@@ -145,6 +149,7 @@ message 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.
+  // * Otherwise, if document's index is in progress, the pending_message field
+  //   is populated.
   IndexStatus index_status = 15 [(google.api.field_behavior) = OUTPUT_ONLY];
 }

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

@@ -281,7 +281,7 @@ message CreateDocumentRequest {
   // 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
+  // standard with a length limit of 128 characters. Otherwise, an
   // `INVALID_ARGUMENT` error is returned.
   string document_id = 3 [(google.api.field_behavior) = REQUIRED];
 }

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

@@ -114,6 +114,20 @@ message Engine {
     // [ChatEngineMetadata.dialogflow_agent][google.cloud.discoveryengine.v1.Engine.ChatEngineMetadata.dialogflow_agent]
     // for actual agent association after Engine is created.
     string dialogflow_agent_to_link = 2;
+
+    // Optional. If the flag set to true, we allow the agent and engine are in
+    // different locations, otherwise the agent and engine are required to be in
+    // the same location. The flag is set to false by default.
+    //
+    // Note that the `allow_cross_region` are one-time consumed by and
+    // passed to
+    // [EngineService.CreateEngine][google.cloud.discoveryengine.v1.EngineService.CreateEngine].
+    // It means they cannot be retrieved using
+    // [EngineService.GetEngine][google.cloud.discoveryengine.v1.EngineService.GetEngine]
+    // or
+    // [EngineService.ListEngines][google.cloud.discoveryengine.v1.EngineService.ListEngines]
+    // API after engine creation.
+    bool allow_cross_region = 3 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Common configurations for an Engine.
@@ -205,9 +219,8 @@ message Engine {
 
   // The industry vertical that the engine registers.
   // The restriction of the Engine industry vertical is based on
-  // [DataStore][google.cloud.discoveryengine.v1.DataStore]: If unspecified,
-  // default to `GENERIC`. Vertical on Engine has to match vertical of the
-  // DataStore linked to the engine.
+  // [DataStore][google.cloud.discoveryengine.v1.DataStore]: Vertical on Engine
+  // has to match vertical of the DataStore linked to the engine.
   IndustryVertical industry_vertical = 16;
 
   // Common config spec that specifies the metadata of the engine.

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

@@ -109,6 +109,9 @@ message GenerateGroundedContentRequest {
     // If specified, custom value for frequency penalty will be used.
     optional float frequency_penalty = 8;
 
+    // If specified, custom value for the seed will be used.
+    optional int32 seed = 12;
+
     // If specified, custom value for presence penalty will be used.
     optional float presence_penalty = 9;
 
@@ -188,6 +191,9 @@ message GenerateGroundedContentRequest {
           [(google.api.field_behavior) = OPTIONAL];
     }
 
+    // Params for using enterprise web retrieval as grounding source.
+    message EnterpriseWebRetrievalSource {}
+
     // Sources.
     oneof source {
       // If set, grounding is performed with inline content.
@@ -198,6 +204,9 @@ message GenerateGroundedContentRequest {
 
       // If set, grounding is performed with Google Search.
       GoogleSearchSource google_search_source = 3;
+
+      // If set, grounding is performed with enterprise web retrieval.
+      EnterpriseWebRetrievalSource enterprise_web_retrieval_source = 8;
     }
   }
 
@@ -228,8 +237,6 @@ message GenerateGroundedContentRequest {
   // For single-turn queries, this is a single instance. For multi-turn queries,
   // this is a repeated field that contains conversation history + latest
   // request.
-  //
-  // Only a single-turn query is supported currently.
   repeated GroundedGenerationContent contents = 2;
 
   // Content generation specification.
@@ -258,6 +265,7 @@ message GenerateGroundedContentRequest {
   map<string, string> user_labels = 6;
 }
 
+// Response for the `GenerateGroundedContent` method.
 message GenerateGroundedContentResponse {
   // A response candidate generated from the model.
   message Candidate {
@@ -347,6 +355,39 @@ message GenerateGroundedContentResponse {
         optional float support_score = 2;
       }
 
+      // Metadata about an image from the web search.
+      message ImageMetadata {
+        // Metadata about the website that the image is from.
+        message WebsiteInfo {
+          // The url of the website.
+          string uri = 1;
+
+          // The title of the website.
+          string title = 2;
+        }
+
+        // Metadata about the image.
+        message Image {
+          // The url of the image.
+          string uri = 1;
+
+          // The width of the image in pixels.
+          int32 width = 2;
+
+          // The height of the image in pixels.
+          int32 height = 3;
+        }
+
+        // Metadata about the full size image.
+        Image image = 1;
+
+        // Metadata about the thumbnail.
+        Image thumbnail = 2;
+
+        // The details about the website that the image is from.
+        WebsiteInfo source = 3;
+      }
+
       // Retrieval metadata to provide an understanding in the
       // retrieval steps performed by the model. There can be multiple such
       // messages which can correspond to different parts of the retrieval. This
@@ -367,6 +408,9 @@ message GenerateGroundedContentResponse {
       // An support to a fact indicates that the claim is supported by
       // the fact.
       repeated GroundingSupport grounding_support = 2;
+
+      // Images from the web search.
+      repeated ImageMetadata images = 9;
     }
 
     // Index of the candidate.
@@ -409,7 +453,7 @@ message CheckGroundingRequest {
     }
   ];
 
-  // Answer candidate to check. Can have a maximum length of 1024 characters.
+  // Answer candidate to check. It can have a maximum length of 4096 tokens.
   string answer_candidate = 2;
 
   // List of facts for the grounding check.
@@ -443,14 +487,30 @@ message CheckGroundingRequest {
 // [GroundedGenerationService.CheckGrounding][google.cloud.discoveryengine.v1.GroundedGenerationService.CheckGrounding]
 // method.
 message CheckGroundingResponse {
+  // Fact chunk for grounding check.
+  message CheckGroundingFactChunk {
+    // Text content of the fact chunk. Can be at most 10K characters long.
+    string chunk_text = 1;
+  }
+
   // Text and citation info for a claim in the answer candidate.
   message Claim {
     // Position indicating the start of the claim in the answer candidate,
-    // measured in bytes.
+    // measured in bytes. Note that this is not measured in characters and,
+    // therefore, must be rendered in the user interface keeping in mind that
+    // some characters may take more than one byte. For example,
+    // if the claim text contains non-ASCII characters, the start and end
+    // positions vary when measured in characters
+    // (programming-language-dependent) and when measured in bytes
+    // (programming-language-independent).
     optional int32 start_pos = 1;
 
     // Position indicating the end of the claim in the answer candidate,
-    // exclusive.
+    // exclusive, in bytes. Note that this is not measured in characters and,
+    // therefore, must be rendered as such. For example, if the claim text
+    // contains non-ASCII characters, the start and end positions vary when
+    // measured in characters (programming-language-dependent) and when measured
+    // in bytes (programming-language-independent).
     optional int32 end_pos = 2;
 
     // Text for the claim in the answer candidate. Always provided regardless of
@@ -468,10 +528,7 @@ message CheckGroundingResponse {
     // decided this claim doesn't require attribution/grounding check, this
     // field will be set to false. In that case, no grounding check was done for
     // the claim and therefore
-    // [citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.citation_indices],
-    // [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices],
-    // and
-    // [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score]
+    // [citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.citation_indices]
     // should not be returned.
     optional bool grounding_check_required = 6;
   }
@@ -485,6 +542,10 @@ message CheckGroundingResponse {
   // These are derived from the facts supplied in the request.
   repeated FactChunk cited_chunks = 3;
 
+  // List of facts cited across all claims in the answer candidate.
+  // These are derived from the facts supplied in the request.
+  repeated CheckGroundingFactChunk cited_facts = 6;
+
   // Claim texts and citation info across all claims in the answer candidate.
   repeated Claim claims = 4;
 }

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

@@ -206,7 +206,7 @@ message BigtableOptions {
   // The type of values in a Bigtable column or column family.
   // The values are expected to be encoded using
   // [HBase
-  // Bytes.toBytes](https://hbase.apache.org/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
+  // Bytes.toBytes](https://hbase.apache.org/1.4/apidocs/org/apache/hadoop/hbase/util/Bytes.html)
   // function when the encoding value is set to `BINARY`.
   enum Type {
     // The type is unspecified.
@@ -296,6 +296,18 @@ message FhirStoreSource {
   // 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;
+
+  // Optional. Whether to update the DataStore schema to the latest predefined
+  // schema.
+  //
+  // If true, the DataStore schema will be updated to include any FHIR fields
+  // or resource types that have been added since the last import and
+  // corresponding FHIR resources will be imported from the FHIR store.
+  //
+  // Note this field cannot be used in conjunction with `resource_types`. It
+  // should be used after initial import.
+  bool update_from_latest_predefined_schema = 4
+      [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Cloud SQL source import data from.
@@ -627,6 +639,13 @@ message ImportDocumentsRequest {
   // * [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource].
   // * [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource].
   string id_field = 9;
+
+  // Optional. Whether to force refresh the unstructured content of the
+  // documents.
+  //
+  // If set to `true`, the content part of the documents will be refreshed
+  // regardless of the update status of the referencing content.
+  bool force_refresh_content = 16 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Response of the

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

@@ -55,16 +55,20 @@ message PurgeUserEventsRequest {
   // * `userId`: Double quoted string. Specifying this will delete all events
   //   associated with a user.
   //
+  // Note: This API only supports purging a max range of 30 days.
+  //
   // Examples:
   //
   // * Deleting all events in a time range:
   //   `eventTime > "2012-04-23T18:25:43.511Z"
   //   eventTime < "2012-04-23T18:30:43.511Z"`
-  // * Deleting specific eventType:
-  //   `eventType = "search"`
-  // * Deleting all events for a specific visitor:
-  //   `userPseudoId = "visitor1024"`
-  // * Deleting all events inside a DataStore:
+  // * Deleting specific eventType in a time range:
+  //   `eventTime > "2012-04-23T18:25:43.511Z"
+  //   eventTime < "2012-04-23T18:30:43.511Z" eventType = "search"`
+  // * Deleting all events for a specific visitor in a time range:
+  //   `eventTime > "2012-04-23T18:25:43.511Z"
+  //   eventTime < "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024"`
+  // * Deleting the past 30 days of events inside a DataStore:
   //   `*`
   //
   // The filtering fields are assumed to have an implicit AND.

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

@@ -66,6 +66,8 @@ message RankingRecord {
   string content = 3;
 
   // The score of this record based on the given query and selected model.
+  // The score will be rounded to 2 decimal places. If the score is close to 0,
+  // it will be rounded to 0.0001 to avoid returning unset.
   float score = 4;
 }
 
@@ -83,7 +85,7 @@ message RankRequest {
 
   // The identifier of the model to use. It is one of:
   //
-  // * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+  // * `semantic-ranker-512@latest`: Semantic ranking model with maximum input
   // token size 512.
   //
   // It is set to `semantic-ranker-512@latest` by default if unspecified.

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

@@ -116,9 +116,9 @@ message RecommendRequest {
   // attribute-based expressions are expected instead of the above described
   // tag-based syntax. Examples:
   //
-  //  * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
+  //  * (language: ANY("en", "es")) AND NOT (categories: ANY("Movie"))
   //  * (available: true) AND
-  //    (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
+  //    (language: ANY("en", "es")) OR (categories: ANY("Movie"))
   //
   // If your filter blocks all results, the API returns generic
   // (unfiltered) popular Documents. If you only want results strictly matching

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

@@ -0,0 +1,107 @@
+// 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/field_behavior.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 = "SafetyProto";
+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";
+
+// Harm categories that will block the content.
+enum HarmCategory {
+  // The harm category is unspecified.
+  HARM_CATEGORY_UNSPECIFIED = 0;
+
+  // The harm category is hate speech.
+  HARM_CATEGORY_HATE_SPEECH = 1;
+
+  // The harm category is dangerous content.
+  HARM_CATEGORY_DANGEROUS_CONTENT = 2;
+
+  // The harm category is harassment.
+  HARM_CATEGORY_HARASSMENT = 3;
+
+  // The harm category is sexually explicit content.
+  HARM_CATEGORY_SEXUALLY_EXPLICIT = 4;
+
+  // The harm category is civic integrity.
+  HARM_CATEGORY_CIVIC_INTEGRITY = 5;
+}
+
+// Safety rating corresponding to the generated content.
+message SafetyRating {
+  // Harm probability levels in the content.
+  enum HarmProbability {
+    // Harm probability unspecified.
+    HARM_PROBABILITY_UNSPECIFIED = 0;
+
+    // Negligible level of harm.
+    NEGLIGIBLE = 1;
+
+    // Low level of harm.
+    LOW = 2;
+
+    // Medium level of harm.
+    MEDIUM = 3;
+
+    // High level of harm.
+    HIGH = 4;
+  }
+
+  // Harm severity levels.
+  enum HarmSeverity {
+    // Harm severity unspecified.
+    HARM_SEVERITY_UNSPECIFIED = 0;
+
+    // Negligible level of harm severity.
+    HARM_SEVERITY_NEGLIGIBLE = 1;
+
+    // Low level of harm severity.
+    HARM_SEVERITY_LOW = 2;
+
+    // Medium level of harm severity.
+    HARM_SEVERITY_MEDIUM = 3;
+
+    // High level of harm severity.
+    HARM_SEVERITY_HIGH = 4;
+  }
+
+  // Output only. Harm category.
+  HarmCategory category = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Harm probability levels in the content.
+  HarmProbability probability = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Harm probability score.
+  float probability_score = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Harm severity levels in the content.
+  HarmSeverity severity = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Harm severity score.
+  float severity_score = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Indicates whether the content was filtered out because of this
+  // rating.
+  bool blocked = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+}