google-cloud-discovery_engine-v1 1.0.1 → 1.1.0

data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb

@@ -179,6 +179,107 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent branch resource name, such as
+        #     `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+        # @!attribute [rw] matcher
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::Matcher]
+        #     Required. Matcher for the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+        class BatchGetDocumentsMetadataRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s by
+          # exact uris.
+          # @!attribute [rw] uris
+          #   @return [::Array<::String>]
+          #     The exact URIs to match by.
+          class UrisMatcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Matcher for the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+          # Currently supports matching by exact URIs.
+          # @!attribute [rw] uris_matcher
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataRequest::UrisMatcher]
+          #     Matcher by exact URIs.
+          class Matcher
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#batch_get_documents_metadata DocumentService.BatchGetDocumentsMetadata}
+        # method.
+        # @!attribute [rw] documents_metadata
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata>]
+        #     The metadata of the {::Google::Cloud::DiscoveryEngine::V1::Document Document}s.
+        class BatchGetDocumentsMetadataResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The metadata of a {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          # @!attribute [rw] matcher_value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::DocumentMetadata::MatcherValue]
+          #     The value of the matcher that was used to match the
+          #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchGetDocumentsMetadataResponse::State]
+          #     The state of the document.
+          # @!attribute [rw] last_refreshed_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The timestamp of the last time the
+          #     {::Google::Cloud::DiscoveryEngine::V1::Document Document} was last indexed.
+          # @!attribute [rw] data_ingestion_source
+          #   @return [::String]
+          #     The data ingestion source of the
+          #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          #
+          #     Allowed values are:
+          #
+          #     * `batch`: Data ingested via Batch API, e.g., ImportDocuments.
+          #     * `streaming` Data ingested via Streaming API, e.g., FHIR streaming.
+          class DocumentMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The value of the matcher that was used to match the
+            # {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+            # @!attribute [rw] uri
+            #   @return [::String]
+            #     If match by URI, the URI of the
+            #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+            class MatcherValue
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # The state of the {::Google::Cloud::DiscoveryEngine::V1::Document Document}.
+          module State
+            # Should never be set.
+            STATE_UNSPECIFIED = 0
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is indexed.
+            INDEXED = 1
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed
+            # because its URI is not in the
+            # {::Google::Cloud::DiscoveryEngine::V1::TargetSite TargetSite}.
+            NOT_IN_TARGET_SITE = 2
+
+            # The {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not indexed.
+            NOT_IN_INDEX = 3
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb

@@ -130,8 +130,9 @@ module Google
           #     field will be set to false. In that case, no grounding check was done for
           #     the claim and therefore
           #     {::Google::Cloud::DiscoveryEngine::V1::CheckGroundingResponse::Claim#citation_indices citation_indices},
+          #     [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices],
           #     and
-          #     [anti_citation_indices][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.anti_citation_indices]
+          #     [score][google.cloud.discoveryengine.v1.CheckGroundingResponse.Claim.score]
           #     should not be returned.
           class Claim
             include ::Google::Protobuf::MessageExts

data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb

@@ -68,7 +68,7 @@ module Google
         #     BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     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.
         # @!attribute [rw] dataset_id
@@ -113,7 +113,7 @@ module Google
         # The Spanner source for importing data
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     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.
         # @!attribute [rw] instance_id
@@ -268,7 +268,7 @@ module Google
         # The Cloud Bigtable source for importing data.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     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.
         # @!attribute [rw] instance_id
@@ -297,6 +297,12 @@ module Google
         #     Intermediate Cloud Storage directory used for the import with a length
         #     limit of 2,000 characters. Can be specified if one wants to have the
         #     FhirStore export to a specific Cloud Storage directory.
+        # @!attribute [rw] resource_types
+        #   @return [::Array<::String>]
+        #     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.
         class FhirStoreSource
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -305,8 +311,8 @@ module Google
         # Cloud SQL source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     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.
         # @!attribute [rw] instance_id
         #   @return [::String]
@@ -341,8 +347,8 @@ module Google
         # AlloyDB source import data from.
         # @!attribute [rw] project_id
         #   @return [::String]
-        #     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.
         # @!attribute [rw] location_id
         #   @return [::String]

data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb

@@ -21,9 +21,107 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1
+        # Request message for PurgeUserEvents method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The resource name of the catalog under which the events are
+        #     created. The format is
+        #     `projects/{project}/locations/global/collections/{collection}/dataStores/{dataStore}`
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Required. The filter string to specify the events to be deleted with a
+        #     length limit of 5,000 characters. The eligible fields for filtering are:
+        #
+        #     * `eventType`: Double quoted
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#event_type UserEvent.event_type}
+        #     string.
+        #     * `eventTime`: in ISO 8601 "zulu" format.
+        #     * `userPseudoId`: Double quoted string. Specifying this will delete all
+        #       events associated with a visitor.
+        #     * `userId`: Double quoted string. Specifying this will delete all events
+        #       associated with a user.
+        #
+        #     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:
+        #       `*`
+        #
+        #     The filtering fields are assumed to have an implicit AND.
+        # @!attribute [rw] force
+        #   @return [::Boolean]
+        #     The `force` field is currently not supported. Purge user event requests
+        #     will permanently delete all purgeable events. Once the development is
+        #     complete:
+        #     If `force` is set to false, the method will return the expected
+        #     purge count without deleting any user events. This field will default to
+        #     false if not included in the request.
+        class PurgeUserEventsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response of the PurgeUserEventsRequest. If the long running operation is
+        # successfully done, then this message is returned by the
+        # google.longrunning.Operations.response field.
+        # @!attribute [rw] purge_count
+        #   @return [::Integer]
+        #     The total count of events purged as a result of the operation.
+        class PurgeUserEventsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeUserEvents operation.
+        # This will be returned by the google.longrunning.Operation.metadata field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of entries that were deleted successfully.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of entries that encountered errors while processing.
+        class PurgeUserEventsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration of destination for Purge related errors.
+        # @!attribute [rw] gcs_prefix
+        #   @return [::String]
+        #     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.
+        class PurgeErrorConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
         # method.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
+        #     Cloud Storage location for the input content.
+        #     Supported `data_schema`:
+        #     * `document_id`: One valid
+        #     {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id} per line.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::PurgeDocumentsRequest::InlineSource]
+        #     Inline source for the input content for purge.
         # @!attribute [rw] parent
         #   @return [::String]
         #     Required. The parent resource name, such as
@@ -33,6 +131,9 @@ module Google
         #     Required. Filter matching documents to purge. Only currently supported
         #     value is
         #     `*` (all items).
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::PurgeErrorConfig]
+        #     The desired location of errors incurred during the purge.
         # @!attribute [rw] force
         #   @return [::Boolean]
         #     Actually performs the purge. If `force` is set to false, return the
@@ -40,6 +141,20 @@ module Google
         class PurgeDocumentsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for the input config for
+          # {::Google::Cloud::DiscoveryEngine::V1::DocumentService::Client#purge_documents DocumentService.PurgeDocuments}
+          # method.
+          # @!attribute [rw] documents
+          #   @return [::Array<::String>]
+          #     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.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Response message for

data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb

@@ -24,7 +24,8 @@ module Google
         # Request message for Recommend method.
         # @!attribute [rw] serving_config
         #   @return [::String]
-        #     Required. Full resource name of a [ServingConfig][]:
+        #     Required. Full resource name of a
+        #     [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]:
         #     `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
         #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
         #

data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb

@@ -120,9 +120,12 @@ module Google
         #     Leave it unset if ordered by relevance. `order_by` expression is
         #     case-sensitive.
         #
-        #     For more information on ordering for retail search, see
-        #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
-        #
+        #     For more information on ordering the website search results, see
+        #     [Order web search
+        #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
+        #     For more information on ordering the healthcare search results, see
+        #     [Order healthcare search
+        #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
         #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
         # @!attribute [rw] user_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1::UserInfo]
@@ -548,11 +551,7 @@ module Google
           # @!attribute [rw] search_result_mode
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SearchResultMode]
           #     Specifies the search result mode. If unspecified, the
-          #     search result mode is based on
-          #     [DataStore.DocumentProcessingConfig.chunking_config][]:
-          #     * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
-          #       it defaults to `CHUNKS`.
-          #     * Otherwise, it defaults to `DOCUMENTS`.
+          #     search result mode defaults to `DOCUMENTS`.
           # @!attribute [rw] chunk_spec
           #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ChunkSpec]
           #     Specifies the chunk spec to be returned from the search response.
@@ -643,6 +642,14 @@ module Google
             #     navigational queries. If this field is set to `true`, we skip
             #     generating summaries for non-summary seeking queries and return
             #     fallback messages instead.
+            # @!attribute [rw] ignore_low_relevant_content
+            #   @return [::Boolean]
+            #     Specifies whether to filter out queries that have low relevance. The
+            #     default value is `false`.
+            #
+            #     If this field is set to `false`, all search results are used regardless
+            #     of relevance to generate answers. If set to `true`, only queries with
+            #     high relevance search results will generate answers.
             # @!attribute [rw] model_prompt_spec
             #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec]
             #     If specified, the spec will be used to modify the prompt provided to
@@ -777,11 +784,7 @@ module Google
             end
 
             # Specifies the search result mode. If unspecified, the
-            # search result mode is based on
-            # [DataStore.DocumentProcessingConfig.chunking_config][]:
-            # * If [DataStore.DocumentProcessingConfig.chunking_config][] is specified,
-            #   it defaults to `CHUNKS`.
-            # * Otherwise, it defaults to `DOCUMENTS`.
+            # search result mode defaults to `DOCUMENTS`.
             module SearchResultMode
               # Default value.
               SEARCH_RESULT_MODE_UNSPECIFIED = 0
@@ -905,7 +908,8 @@ module Google
         #     A unique search token. This should be included in the
         #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent UserEvent} logs resulting from
         #     this search, which enables accurate attribution of search model
-        #     performance.
+        #     performance. This also helps to identify a request during the customer
+        #     support scenarios.
         # @!attribute [rw] redirect_uri
         #   @return [::String]
         #     The URI of a customer-defined redirect page. If redirect action is
@@ -1121,14 +1125,14 @@ module Google
 
               # The adversarial query ignored case.
               #
-              # Only populated when
+              # Only used when
               # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_adversarial_query SummarySpec.ignore_adversarial_query}
               # is set to `true`.
               ADVERSARIAL_QUERY_IGNORED = 1
 
               # The non-summary seeking query ignored case.
               #
-              # Only populated when
+              # Only used when
               # {::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec#ignore_non_summary_seeking_query SummarySpec.ignore_non_summary_seeking_query}
               # is set to `true`.
               NON_SUMMARY_SEEKING_QUERY_IGNORED = 2
@@ -1150,6 +1154,26 @@ module Google
               #
               # Google skips the summary if the LLM addon is not enabled.
               LLM_ADDON_NOT_ENABLED = 5
+
+              # The no relevant content case.
+              #
+              # Google skips the summary if there is no relevant content in the
+              # retrieved search results.
+              NO_RELEVANT_CONTENT = 6
+
+              # The jail-breaking query ignored case.
+              #
+              # For example, "Reply in the tone of a competing company's CEO".
+              # Only used when
+              # [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query]
+              # is set to `true`.
+              JAIL_BREAKING_QUERY_IGNORED = 7
+
+              # 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 = 8
             end
           end
 

data/proto_docs/google/cloud/discoveryengine/v1/search_tuning_service.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# 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
+#
+#     https://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.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     Required. The resource name of the parent Data Store, such as
+        #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+        #     This field is used to identify the data store where to fetch the models
+        #     from.
+        class ListCustomModelsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
+        # method.
+        # @!attribute [rw] models
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::CustomTuningModel>]
+        #     List of custom tuning models.
+        class ListCustomModelsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
+        # method.
+        # @!attribute [rw] gcs_training_input
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::TrainCustomModelRequest::GcsTrainingInput]
+        #     Cloud Storage training input.
+        # @!attribute [rw] data_store
+        #   @return [::String]
+        #     Required. The resource name of the Data Store, such as
+        #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+        #     This field is used to identify the data store where to train the models.
+        # @!attribute [rw] model_type
+        #   @return [::String]
+        #     Model to be trained. Supported values are:
+        #
+        #      * **search-tuning**: Fine tuning the search system based on data provided.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
+        #     The desired location of errors incurred during the data ingestion and
+        #     training.
+        # @!attribute [rw] model_id
+        #   @return [::String]
+        #     If not provided, a UUID will be generated.
+        class TrainCustomModelRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Cloud Storage training data input.
+          # @!attribute [rw] corpus_data_path
+          #   @return [::String]
+          #     The Cloud Storage corpus data which could be associated in train data.
+          #     The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
+          #     A newline delimited jsonl/ndjson file.
+          #
+          #     For search-tuning model, each line should have the _id, title
+          #     and text. Example:
+          #     `{"_id": "doc1", title: "relevant doc", "text": "relevant text"}`
+          # @!attribute [rw] query_data_path
+          #   @return [::String]
+          #     The gcs query data which could be associated in train data.
+          #     The data path format is `gs://<bucket_to_data>/<jsonl_file_name>`.
+          #     A newline delimited jsonl/ndjson file.
+          #
+          #     For search-tuning model, each line should have the _id
+          #     and text. Example: \\{"_id": "query1",  "text": "example query"}
+          # @!attribute [rw] train_data_path
+          #   @return [::String]
+          #     Cloud Storage training data path whose format should be
+          #     `gs://<bucket_to_data>/<tsv_file_name>`. The file should be in tsv
+          #     format. Each line should have the doc_id and query_id and score (number).
+          #
+          #     For search-tuning model, it should have the query-id corpus-id
+          #     score as tsv file header. The score should be a number in `[0, inf+)`.
+          #     The larger the number is, the more relevant the pair is. Example:
+          #
+          #     * `query-id\tcorpus-id\tscore`
+          #     * `query1\tdoc1\t1`
+          # @!attribute [rw] test_data_path
+          #   @return [::String]
+          #     Cloud Storage test data. Same format as train_data_path. If not provided,
+          #     a random 80/20 train/test split will be performed on train_data_path.
+          class GcsTrainingInput
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response of the
+        # {::Google::Cloud::DiscoveryEngine::V1::TrainCustomModelRequest TrainCustomModelRequest}.
+        # This message is returned by the google.longrunning.Operations.response field.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the data.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig]
+        #     Echoes the destination for the complete errors in the request if set.
+        # @!attribute [rw] model_status
+        #   @return [::String]
+        #     The trained model status. Possible values are:
+        #
+        #      * **bad-data**: The training data quality is bad.
+        #      * **no-improvement**: Tuning didn't improve performance. Won't deploy.
+        #      * **in-progress**: Model training job creation is in progress.
+        #      * **training**: Model is actively training.
+        #      * **evaluating**: The model is evaluating trained metrics.
+        #      * **indexing**: The model trained metrics are indexing.
+        #      * **ready**: The model is ready for serving.
+        # @!attribute [rw] metrics
+        #   @return [::Google::Protobuf::Map{::String => ::Float}]
+        #     The metrics of the trained model.
+        # @!attribute [rw] model_name
+        #   @return [::String]
+        #     Fully qualified name of the CustomTuningModel.
+        class TrainCustomModelResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Float]
+          class MetricsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Metadata related to the progress of the TrainCustomModel operation. This is
+        # returned by the google.longrunning.Operation.metadata field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Operation last update time. If the operation is done, this is also the
+        #     finish time.
+        class TrainCustomModelMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb

@@ -447,6 +447,10 @@ module Google
         #   @return [::Array<::String>]
         #     The promotion IDs associated with this Document.
         #     Currently, this field is restricted to at most one ID.
+        # @!attribute [r] joined
+        #   @return [::Boolean]
+        #     Output only. Whether the referenced Document can be found in the data
+        #     store.
         class DocumentInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods