googleapis · gcf-owl-bot · Oct 10, 2024 · Oct 10, 2024 · Oct 10, 2024 · Oct 10, 2024
@@ -1,4 +1,4 @@
-// Copyright 2024 Google LLC
+// 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.
@@ -40,7 +40,7 @@ module.exports = {
     includePattern: '\\.js$'
   },
   templates: {
-    copyright: 'Copyright 2024 Google LLC',
+    copyright: 'Copyright 2025 Google LLC',
     includeDate: false,
     sourceFiles: false,
     systemName: '@google-cloud/discoveryengine',

@@ -1,4 +1,4 @@
-// Copyright 2024 Google LLC
+// 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.

@@ -1,4 +1,4 @@
-// Copyright 2024 Google LLC
+// 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.

@@ -280,11 +280,14 @@ message Answer {
         // Adversarial query classification type.
         ADVERSARIAL_QUERY = 1;
 
-        // Non-answer-seeking query classification type.
+        // Non-answer-seeking query classification type, for chit chat.
         NON_ANSWER_SEEKING_QUERY = 2;
 
         // Jail-breaking query classification type.
         JAIL_BREAKING_QUERY = 3;
+
+        // Non-answer-seeking query classification type, for no clear intent.
+        NON_ANSWER_SEEKING_QUERY_V2 = 4;
       }
 
       // Query classification type.
@@ -321,7 +324,9 @@ message Answer {
     // The adversarial query ignored case.
     ADVERSARIAL_QUERY_IGNORED = 1;
 
-    // The non-answer seeking query ignored case.
+    // The non-answer seeking query ignored case
+    //
+    // Google skips the answer if the query is chit chat.
     NON_ANSWER_SEEKING_QUERY_IGNORED = 2;
 
     // The out-of-domain query ignored case.
@@ -353,6 +358,17 @@ message Answer {
     // Google skips the summary if there is a customer policy violation
     // detected. The policy is defined by the customer.
     CUSTOMER_POLICY_VIOLATION = 7;
+
+    // The non-answer seeking query ignored case.
+    //
+    // Google skips the answer if the query doesn't have clear intent.
+    NON_ANSWER_SEEKING_QUERY_IGNORED_V2 = 8;
+
+    // The low-grounded answer case.
+    //
+    // Google skips the answer if a well grounded answer was unable to be
+    // generated.
+    LOW_GROUNDED_ANSWER = 9;
   }
 
   // Immutable. Fully qualified name

@@ -57,6 +57,10 @@ 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: "healthcare.googleapis.com/FhirResource"
+  pattern: "projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}/fhir/{resource_type}/{fhir_resource_id}"
+};
 
 // The industry vertical associated with the
 // [DataStore][google.cloud.discoveryengine.v1.DataStore].

@@ -62,6 +62,9 @@ message Condition {
 
   // Search only
   // A list of terms to match the query on.
+  // Cannot be set when
+  // [Condition.query_regex][google.cloud.discoveryengine.v1.Condition.query_regex]
+  // is set.
   //
   // Maximum of 10 query terms.
   repeated QueryTerm query_terms = 2;
@@ -70,6 +73,12 @@ message Condition {
   //
   // Maximum of 10 time ranges.
   repeated TimeRange active_time_range = 3;
+
+  // Optional. Query regex to match the whole search query.
+  // Cannot be set when
+  // [Condition.query_terms][google.cloud.discoveryengine.v1.Condition.query_terms]
+  // is set. This is currently supporting promotion use case.
+  string query_regex = 4 [(google.api.field_behavior) = OPTIONAL];
 }
 
 // Defines a conditioned behavior to employ during serving.

@@ -135,9 +135,9 @@ service ControlService {
 // Request for CreateControl method.
 message CreateControlRequest {
   // Required. Full resource name of parent data store. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
   // or
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -176,7 +176,7 @@ message UpdateControlRequest {
 // Request for DeleteControl method.
 message DeleteControlRequest {
   // Required. The resource name of the Control to delete. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -188,7 +188,7 @@ message DeleteControlRequest {
 // Request for GetControl method.
 message GetControlRequest {
   // Required. The resource name of the Control to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -200,9 +200,9 @@ message GetControlRequest {
 // Request for ListControls method.
 message ListControlsRequest {
   // Required. The data store resource name. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`
   // or
-  // `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
+  // `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {

@@ -273,9 +273,9 @@ service ConversationalSearchService {
 // method.
 message ConverseConversationRequest {
   // Required. The resource name of the Conversation to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`.
   // Use
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/-`
   // to activate auto session mode, which automatically creates a new
   // conversation inside a ConverseConversation session.
   string name = 1 [
@@ -289,7 +289,7 @@ message ConverseConversationRequest {
   TextInput query = 2 [(google.api.field_behavior) = REQUIRED];
 
   // The resource name of the Serving Config to use. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
   // If this is not set, the default serving config will be used.
   string serving_config = 3 [(google.api.resource_reference) = {
     type: "discoveryengine.googleapis.com/ServingConfig"
@@ -366,7 +366,7 @@ message ConverseConversationResponse {
 // Request for CreateConversation method.
 message CreateConversationRequest {
   // Required. Full resource name of parent data store. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -396,7 +396,7 @@ message UpdateConversationRequest {
 // Request for DeleteConversation method.
 message DeleteConversationRequest {
   // Required. The resource name of the Conversation to delete. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -408,7 +408,7 @@ message DeleteConversationRequest {
 // Request for GetConversation method.
 message GetConversationRequest {
   // Required. The resource name of the Conversation to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -420,7 +420,7 @@ message GetConversationRequest {
 // Request for ListConversations method.
 message ListConversationsRequest {
   // Required. The data store resource name. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -540,6 +540,20 @@ message AnswerQueryRequest {
     // of relevance to generate answers. If set to `true` or unset, the behavior
     // will be determined automatically by the service.
     optional bool ignore_low_relevant_content = 7;
+
+    // Optional. Specifies whether to filter out jail-breaking queries. The
+    // default value is `false`.
+    //
+    // Google employs search-query classification to detect jail-breaking
+    // queries. No summary is returned if the search query is classified as a
+    // jail-breaking query. A user might add instructions to the query to
+    // change the tone, style, language, content of the answer, or ask the
+    // model to act as a different entity, e.g. "Reply in the tone of a
+    // competing company's CEO". If this field is set to `true`, we skip
+    // generating summaries for jail-breaking queries and return fallback
+    // messages instead.
+    bool ignore_jail_breaking_query = 8
+        [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Search specification.
@@ -607,12 +621,14 @@ message AnswerQueryRequest {
             // Page identifier.
             string page_identifier = 1;
 
-            // Document content.
+            // Document content to be used for answer generation.
             string content = 2;
           }
 
           // Extractive segment.
           // [Guide](https://cloud.google.com/generative-ai-app-builder/docs/snippets#extractive-segments)
+          // Answer generation will only use it if document_contexts is empty.
+          // This is supposed to be shorter snippets.
           message ExtractiveSegment {
             // Page identifier.
             string page_identifier = 1;
@@ -642,25 +658,43 @@ message AnswerQueryRequest {
           // Title.
           string title = 3;
 
-          // List of document contexts.
+          // List of document contexts. The content will be used for Answer
+          // Generation. This is supposed to be the main content of the document
+          // that can be long and comprehensive.
           repeated DocumentContext document_contexts = 4;
 
           // List of extractive segments.
           repeated ExtractiveSegment extractive_segments = 5;
 
+          // Deprecated: This field is deprecated and will have no effect on
+          // the Answer generation.
+          // Please use document_contexts and extractive_segments fields.
           // List of extractive answers.
-          repeated ExtractiveAnswer extractive_answers = 6;
+          repeated ExtractiveAnswer extractive_answers = 6 [deprecated = true];
         }
 
         // Chunk information.
         message ChunkInfo {
+          // 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;
+          }
+
           // Chunk resource name.
           string chunk = 1 [(google.api.resource_reference) = {
             type: "discoveryengine.googleapis.com/Chunk"
           }];
 
           // Chunk textual content.
           string content = 2;
+
+          // Metadata of the document from the current chunk.
+          DocumentMetadata document_metadata = 4;
         }
 
         // Search result content.
@@ -700,11 +734,14 @@ message AnswerQueryRequest {
         // Adversarial query classification type.
         ADVERSARIAL_QUERY = 1;
 
-        // Non-answer-seeking query classification type.
+        // Non-answer-seeking query classification type, for chit chat.
         NON_ANSWER_SEEKING_QUERY = 2;
 
         // Jail-breaking query classification type.
         JAIL_BREAKING_QUERY = 3;
+
+        // Non-answer-seeking query classification type, for no clear intent.
+        NON_ANSWER_SEEKING_QUERY_V2 = 4;
       }
 
       // Enabled query classification types.
@@ -770,6 +807,9 @@ message AnswerQueryRequest {
   // Query understanding specification.
   QueryUnderstandingSpec query_understanding_spec = 9;
 
+  // Deprecated: This field is deprecated. Streaming Answer API will be
+  // supported.
+  //
   // Asynchronous mode control.
   //
   // If enabled, the response will be returned with answer/session resource
@@ -779,7 +819,7 @@ message AnswerQueryRequest {
   // or
   // [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1.ConversationalSearchService.GetSession]
   // method.
-  bool asynchronous_mode = 10;
+  bool asynchronous_mode = 10 [deprecated = true];
 
   // A unique identifier for tracking visitors. For example, this could be
   // implemented with an HTTP cookie, which should be able to uniquely identify
@@ -839,7 +879,7 @@ message AnswerQueryResponse {
 // Request for GetAnswer method.
 message GetAnswerRequest {
   // Required. The resource name of the Answer to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -851,7 +891,7 @@ message GetAnswerRequest {
 // Request for CreateSession method.
 message CreateSessionRequest {
   // Required. Full resource name of parent data store. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -881,7 +921,7 @@ message UpdateSessionRequest {
 // Request for DeleteSession method.
 message DeleteSessionRequest {
   // Required. The resource name of the Session to delete. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -893,7 +933,7 @@ message DeleteSessionRequest {
 // Request for GetSession method.
 message GetSessionRequest {
   // Required. The resource name of the Session to get. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -905,7 +945,7 @@ message GetSessionRequest {
 // Request for ListSessions method.
 message ListSessionsRequest {
   // Required. The data store resource name. Format:
-  // `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}`
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {

@@ -67,8 +67,9 @@ message CustomTuningModel {
   // Required. The fully qualified resource name of the model.
   //
   // Format:
-  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
-  // model must be an alpha-numerical string with limit of 40 characters.
+  // `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.
+  //
+  // Model must be an alpha-numerical string with limit of 40 characters.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -85,12 +86,16 @@ message CustomTuningModel {
   // The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
   ModelState model_state = 4;
 
-  // Deprecated: timestamp the Model was created at.
+  // Deprecated: Timestamp the Model was created at.
   google.protobuf.Timestamp create_time = 5 [deprecated = true];
 
   // Timestamp the model training was initiated.
   google.protobuf.Timestamp training_start_time = 6;
 
   // The metrics of the trained model.
   map<string, double> metrics = 7;
+
+  // Currently this is only populated if the model state is
+  // `INPUT_VALIDATION_FAILED`.
+  string error_message = 8;
 }