google-cloud-discovery_engine-v1beta 0.9.0 → 0.11.0

data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb

@@ -0,0 +1,99 @@
+# 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 V1beta
+        # Record message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
+        # method.
+        # @!attribute [rw] id
+        #   @return [::String]
+        #     The unique ID to represent the record.
+        # @!attribute [rw] title
+        #   @return [::String]
+        #     The title of the record. Empty by default.
+        #     At least one of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
+        #     be set otherwise an INVALID_ARGUMENT error is thrown.
+        # @!attribute [rw] content
+        #   @return [::String]
+        #     The content of the record. Empty by default.
+        #     At least one of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord#content content} should
+        #     be set otherwise an INVALID_ARGUMENT error is thrown.
+        # @!attribute [rw] score
+        #   @return [::Float]
+        #     The score of this record based on the given query and selected model.
+        class RankingRecord
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
+        # method.
+        # @!attribute [rw] ranking_config
+        #   @return [::String]
+        #     Required. The resource name of the rank service config, such as
+        #     `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+        # @!attribute [rw] model
+        #   @return [::String]
+        #     The identifier of the model to use. It is one of:
+        #
+        #     * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input
+        #     token size 512.
+        #
+        #     It is set to `semantic-ranker-512@latest` by default if unspecified.
+        # @!attribute [rw] top_n
+        #   @return [::Integer]
+        #     The number of results to return. If this is unset or no bigger than zero,
+        #     returns all results.
+        # @!attribute [rw] query
+        #   @return [::String]
+        #     The query to use.
+        # @!attribute [rw] records
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
+        #     Required. A list of records to rank. At most 200 records to rank.
+        # @!attribute [rw] ignore_record_details_in_response
+        #   @return [::Boolean]
+        #     If true, the response will contain only record ID and score. By default, it
+        #     is false, the response will contain record details.
+        class RankRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::RankService::Client#rank RankService.Rank}
+        # method.
+        # @!attribute [rw] records
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::RankingRecord>]
+        #     A list of records sorted by descending score.
+        class RankResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -48,10 +48,14 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
-        #     to return. If unspecified, defaults to a reasonable value. The maximum
-        #     allowed value is 100. Values above 100 are coerced to 100.
+        #     to return. The maximum allowed value depends on the data type. Values above
+        #     the maximum value are coerced to the maximum value.
         #
-        #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        #     * Websites with basic indexing: Default `10`, Maximum `25`.
+        #     * Websites with advanced indexing: Default `25`, Maximum `50`.
+        #     * Other: Default `50`, Maximum `100`.
+        #
+        #     If this field is negative, an  `INVALID_ARGUMENT` is returned.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token received from a previous
@@ -72,6 +76,9 @@ module Google
         #     is unset.
         #
         #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+        # @!attribute [rw] data_store_specs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
+        #     A list of data store specs to apply on a search call.
         # @!attribute [rw] filter
         #   @return [::String]
         #     The filter syntax consists of an expression language for constructing a
@@ -185,7 +192,8 @@ module Google
         #
         #     If
         #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::EmbeddingSpec::EmbeddingVector#field_path SearchRequest.EmbeddingSpec.EmbeddingVector.field_path}
-        #     is not provided, it will use [ServingConfig.EmbeddingConfig.field_path][].
+        #     is not provided, it will use
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig#embedding_config ServingConfig.EmbeddingConfig.field_path}.
         # @!attribute [rw] ranking_expression
         #   @return [::String]
         #     The ranking expression controls the customized ranking on retrieval
@@ -245,6 +253,17 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # A struct to define data stores to filter on in a search call.
+          # @!attribute [rw] data_store
+          #   @return [::String]
+          #     Required. Full resource name of
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, such as
+          #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+          class DataStoreSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # A facet specification to perform faceted search.
           # @!attribute [rw] facet_key
           #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey]
@@ -404,31 +423,116 @@ module Google
             #     Examples:
             #
             #     * To boost documents with document ID "doc_1" or "doc_2", and
-            #     color
-            #       "Red" or "Blue":
-            #         * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
+            #     color "Red" or "Blue":
+            #     `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
             # @!attribute [rw] boost
             #   @return [::Float]
             #     Strength of the condition boost, which should be in [-1, 1]. Negative
             #     boost means demotion. Default is 0.0.
             #
-            #     Setting to 1.0 gives the document a big promotion. However, it does not
-            #     necessarily mean that the boosted document will be the top result at
-            #     all times, nor that other documents will be excluded. Results could
-            #     still be shown even when none of them matches the condition. And
-            #     results that are significantly more relevant to the search query can
-            #     still trump your heavily favored but irrelevant documents.
+            #     Setting to 1.0 gives the document a big promotion. However, it does
+            #     not necessarily mean that the boosted document will be the top result
+            #     at all times, nor that other documents will be excluded. Results
+            #     could still be shown even when none of them matches the condition.
+            #     And results that are significantly more relevant to the search query
+            #     can still trump your heavily favored but irrelevant documents.
             #
             #     Setting to -1.0 gives the document a big demotion. However, results
             #     that are deeply relevant might still be shown. The document will have
-            #     an upstream battle to get a fairly high ranking, but it is not blocked
-            #     out completely.
+            #     an upstream battle to get a fairly high ranking, but it is not
+            #     blocked out completely.
             #
             #     Setting to 0.0 means no boost applied. The boosting condition is
-            #     ignored.
+            #     ignored. Only one of the (condition, boost) combination or the
+            #     boost_control_spec below are set. If both are set then the global boost
+            #     is ignored and the more fine-grained boost_control_spec is applied.
+            # @!attribute [rw] boost_control_spec
+            #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec]
+            #     Complex specification for custom ranking based on customer defined
+            #     attribute value.
             class ConditionBoostSpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Specification for custom ranking based on customer specified attribute
+              # value. It provides more controls for customized ranking than the simple
+              # (condition, boost) combination above.
+              # @!attribute [rw] field_name
+              #   @return [::String]
+              #     The name of the field whose value will be used to determine the
+              #     boost amount.
+              # @!attribute [rw] attribute_type
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
+              #     The attribute type to be used to determine the boost amount. The
+              #     attribute value can be derived from the field value of the specified
+              #     field_name. In the case of numerical it is straightforward i.e.
+              #     attribute_value = numerical_field_value. In the case of freshness
+              #     however, attribute_value = (time.now() - datetime_field_value).
+              # @!attribute [rw] interpolation_type
+              #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
+              #     The interpolation type to be applied to connect the control points
+              #     listed below.
+              # @!attribute [rw] control_points
+              #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
+              #     The control points used to define the curve. The monotonic function
+              #     (defined through the interpolation_type above) passes through the
+              #     control points listed here.
+              class BoostControlSpec
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+
+                # The control points used to define the curve. The curve defined
+                # through these control points can only be monotonically increasing
+                # or decreasing(constant values are acceptable).
+                # @!attribute [rw] attribute_value
+                #   @return [::String]
+                #     Can be one of:
+                #     1. The numerical field value.
+                #     2. The duration spec for freshness:
+                #     The value must be formatted as an XSD `dayTimeDuration` value (a
+                #     restricted subset of an ISO 8601 duration value). The pattern for
+                #     this is: `[nD][T[nH][nM][nS]]`.
+                # @!attribute [rw] boost_amount
+                #   @return [::Float]
+                #     The value between -1 to 1 by which to boost the score if the
+                #     attribute_value evaluates to the value specified above.
+                class ControlPoint
+                  include ::Google::Protobuf::MessageExts
+                  extend ::Google::Protobuf::MessageExts::ClassMethods
+                end
+
+                # The attribute(or function) for which the custom ranking is to be
+                # applied.
+                module AttributeType
+                  # Unspecified AttributeType.
+                  ATTRIBUTE_TYPE_UNSPECIFIED = 0
+
+                  # The value of the numerical field will be used to dynamically update
+                  # the boost amount. In this case, the attribute_value (the x value)
+                  # of the control point will be the actual value of the numerical
+                  # field for which the boost_amount is specified.
+                  NUMERICAL = 1
+
+                  # For the freshness use case the attribute value will be the duration
+                  # between the current time and the date in the datetime field
+                  # specified. The value must be formatted as an XSD `dayTimeDuration`
+                  # value (a restricted subset of an ISO 8601 duration value). The
+                  # pattern for this is: `[nD][T[nH][nM][nS]]`.
+                  # E.g. `5D`, `3DT12H30M`, `T24H`.
+                  FRESHNESS = 2
+                end
+
+                # The interpolation type to be applied. Default will be linear
+                # (Piecewise Linear).
+                module InterpolationType
+                  # Interpolation type is unspecified. In this case, it defaults to
+                  # Linear.
+                  INTERPOLATION_TYPE_UNSPECIFIED = 0
+
+                  # Piecewise linear interpolation will be applied.
+                  LINEAR = 1
+                end
+              end
             end
           end
 
@@ -540,7 +644,7 @@ module Google
             #     of results returned is less than `summaryResultCount`, the summary is
             #     generated from all of the results.
             #
-            #     At most five results can be used to generate a summary.
+            #     At most 10 results can be used to generate a summary.
             # @!attribute [rw] include_citations
             #   @return [::Boolean]
             #     Specifies whether to include citations in the summary. The default
@@ -598,6 +702,14 @@ module Google
             #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec]
             #     If specified, the spec will be used to modify the model specification
             #     provided to the LLM.
+            # @!attribute [rw] use_semantic_chunks
+            #   @return [::Boolean]
+            #     If true, answer will be generated from most relevant chunks from top
+            #     search results. This feature will improve summary quality.
+            #     Note that with this feature enabled, not all top search results
+            #     will be referenced and included in the reference list, so the citation
+            #     source index only points to the search results listed in the reference
+            #     list.
             class SummarySpec
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -620,11 +732,13 @@ module Google
               #     Supported values are:
               #
               #     * `stable`: string. Default value when no value is specified. Uses a
-              #       generally available, fine-tuned version of the text-bison@001
-              #       model.
-              #     * `preview`: string. (Public preview) Uses a fine-tuned version of
-              #       the text-bison@002 model. This model works only for summaries in
-              #       English.
+              #        generally available, fine-tuned model. For more information, see
+              #        [Answer generation model versions and
+              #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              #     * `preview`: string. (Public preview) Uses a preview model. For more
+              #        information, see
+              #        [Answer generation model versions and
+              #        lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
               class ModelSpec
                 include ::Google::Protobuf::MessageExts
                 extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -670,10 +784,9 @@ module Google
             # @!attribute [rw] return_extractive_segment_score
             #   @return [::Boolean]
             #     Specifies whether to return the confidence score from the extractive
-            #     segments in each search result. The default value is `false`.
-            #
-            #     Note: this is a priavte preview feature and only works for allowlisted
-            #     users, please reach out to Cloud Support team if you want to use it.
+            #     segments in each search result. This feature is available only for new
+            #     or allowlisted data stores. To allowlist your data store,
+            #     contact your Customer Engineer. The default value is `false`.
             # @!attribute [rw] num_previous_segments
             #   @return [::Integer]
             #     Specifies whether to also include the adjacent from each selected
@@ -785,6 +898,10 @@ module Google
         # @!attribute [rw] applied_controls
         #   @return [::Array<::String>]
         #     Controls applied as part of the Control service.
+        # @!attribute [rw] geo_search_debug_info
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>]
+        #     Debug information specifically related to forward geocoding issues arising
+        #     from Geolocation Search.
         # @!attribute [rw] query_expansion_info
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
         #     Query expansion information for the returned results.
@@ -958,9 +1075,24 @@ module Google
             # @!attribute [rw] uri
             #   @return [::String]
             #     Cloud Storage or HTTP uri for the document.
+            # @!attribute [rw] chunk_contents
+            #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Summary::Reference::ChunkContent>]
+            #     List of cited chunk contents derived from document content.
             class Reference
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # Chunk content.
+              # @!attribute [rw] content
+              #   @return [::String]
+              #     Chunk textual content.
+              # @!attribute [rw] page_identifier
+              #   @return [::String]
+              #     Page identifier.
+              class ChunkContent
+                include ::Google::Protobuf::MessageExts
+                extend ::Google::Protobuf::MessageExts::ClassMethods
+              end
             end
 
             # Summary with metadata information.
@@ -1017,6 +1149,19 @@ module Google
             end
           end
 
+          # Debug information specifically related to forward geocoding issues arising
+          # from Geolocation Search.
+          # @!attribute [rw] original_address_query
+          #   @return [::String]
+          #     The address from which forward geocoding ingestion produced issues.
+          # @!attribute [rw] error_message
+          #   @return [::String]
+          #     The error produced.
+          class GeoSearchDebugInfo
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Information describing query expansion including whether expansion has
           # occurred.
           # @!attribute [rw] expanded_query

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

@@ -0,0 +1,141 @@
+# 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 V1beta
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
+        # method.
+        # @!attribute [rw] gcs_training_input
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the data ingestion and
+        #     training.
+        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::V1beta::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::V1beta::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.
+        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/v1beta/serving_config.rb

@@ -34,7 +34,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Immutable. Fully qualified name
-        #     `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}`
+        #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
         # @!attribute [rw] display_name
         #   @return [::String]
         #     Required. The human readable serving config display name. Used in Discovery
@@ -87,8 +87,9 @@ module Google
         #     The ranking expression controls the customized ranking on retrieval
         #     documents. To leverage this, document embedding is required. The ranking
         #     expression setting in ServingConfig applies to all search requests served
-        #     by the serving config. However, if [SearchRequest.ranking_expression][] is
-        #     specified, it overrides the ServingConfig ranking expression.
+        #     by the serving config. However, if
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#ranking_expression SearchRequest.ranking_expression}
+        #     is specified, it overrides the ServingConfig ranking expression.
         #
         #     The ranking expression is a single function or multiple functions that are
         #     joined by "+".

data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config_service.rb

@@ -43,7 +43,7 @@ module Google
         # @!attribute [rw] name
         #   @return [::String]
         #     Required. The resource name of the ServingConfig to get. Format:
-        #     `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config_id}`
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
         class GetServingConfigRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -52,8 +52,8 @@ module Google
         # Request for ListServingConfigs method.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The dataStore resource name. Format:
-        #     `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}`
+        #     Required. Full resource name of the parent resource. Format:
+        #     `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Maximum number of results to return. If unspecified, defaults

data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb

@@ -0,0 +1,85 @@
+# 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 V1beta
+        # External session proto definition.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. Fully qualified name
+        #     `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
+        # @!attribute [rw] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Session::State]
+        #     The state of the session.
+        # @!attribute [rw] user_pseudo_id
+        #   @return [::String]
+        #     A unique identifier for tracking users.
+        # @!attribute [rw] turns
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Session::Turn>]
+        #     Turns.
+        # @!attribute [r] start_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session started.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time the session finished.
+        class Session
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents a turn, including a query from the user and a
+          # answer from service.
+          # @!attribute [rw] query
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Query]
+          #     The user query.
+          # @!attribute [rw] answer
+          #   @return [::String]
+          #     The resource name of the answer to the user query.
+          class Turn
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Enumeration of the state of the session.
+          module State
+            # State is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The session is currently open.
+            IN_PROGRESS = 1
+          end
+        end
+
+        # Defines a user inputed query.
+        # @!attribute [rw] text
+        #   @return [::String]
+        #     Plain text.
+        # @!attribute [rw] query_id
+        #   @return [::String]
+        #     Unique Id for the query.
+        class Query
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end