google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0

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

@@ -0,0 +1,223 @@
+# 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
+        # An evaluation is a single execution (or run) of an evaluation process. It
+        # encapsulates the state of the evaluation and the resulting data.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The full resource name of the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}, in the format
+        #     of `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] evaluation_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec]
+        #     Required. The specification of the evaluation.
+        # @!attribute [r] quality_metrics
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics]
+        #     Output only. The metrics produced by the evaluation, averaged across all
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s in the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
+        #
+        #     Only populated when the evaluation's state is SUCCEEDED.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::State]
+        #     Output only. The state of the evaluation.
+        # @!attribute [r] error
+        #   @return [::Google::Rpc::Status]
+        #     Output only. The error that occurred during evaluation. Only populated when
+        #     the evaluation's state is FAILED.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation} was created
+        #     at.
+        # @!attribute [r] end_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation} was completed
+        #     at.
+        # @!attribute [r] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     Output only. A sample of errors encountered while processing the request.
+        class Evaluation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Describes the specification of the evaluation.
+          # @!attribute [rw] search_request
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest]
+          #     Required. The search request that is used to perform the evaluation.
+          #
+          #     Only the following fields within SearchRequest are supported; if any
+          #     other fields are provided, an UNSUPPORTED error will be returned:
+          #
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#serving_config SearchRequest.serving_config}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#branch SearchRequest.branch}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#canonical_filter SearchRequest.canonical_filter}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#query_expansion_spec SearchRequest.query_expansion_spec}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#spell_correction_spec SearchRequest.spell_correction_spec}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#content_search_spec SearchRequest.content_search_spec}
+          #     * {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}
+          # @!attribute [rw] query_set_spec
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation::EvaluationSpec::QuerySetSpec]
+          #     Required. The specification of the query set.
+          class EvaluationSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Describes the specification of the query set.
+            # @!attribute [rw] sample_query_set
+            #   @return [::String]
+            #     Required. The full resource name of the
+            #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}
+            #     used for the evaluation, in the format of
+            #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+            class QuerySetSpec
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # Describes the state of an evaluation.
+          module State
+            # The evaluation is unspecified.
+            STATE_UNSPECIFIED = 0
+
+            # The service is preparing to run the evaluation.
+            PENDING = 1
+
+            # The evaluation is in progress.
+            RUNNING = 2
+
+            # The evaluation completed successfully.
+            SUCCEEDED = 3
+
+            # The evaluation failed.
+            FAILED = 4
+          end
+        end
+
+        # Describes the metrics produced by the evaluation.
+        # @!attribute [rw] doc_recall
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics::TopkMetrics]
+        #     Recall per document, at various top-k cutoff levels.
+        #
+        #     Recall is the fraction of relevant documents retrieved out of all
+        #     relevant documents.
+        #
+        #     Example (top-5):
+        #      * For a single
+        #      {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, If 3 out
+        #      of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+        # @!attribute [rw] doc_precision
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics::TopkMetrics]
+        #     Precision per document, at various top-k cutoff levels.
+        #
+        #     Precision is the fraction of retrieved documents that are relevant.
+        #
+        #     Example (top-5):
+        #      * For a single
+        #      {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, If 4 out
+        #      of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 =
+        #      0.8
+        # @!attribute [rw] doc_ndcg
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics::TopkMetrics]
+        #     Normalized discounted cumulative gain (NDCG) per document, at various top-k
+        #     cutoff levels.
+        #
+        #     NDCG measures the ranking quality, giving higher relevance to top
+        #     results.
+        #
+        #     Example (top-3):
+        #      Suppose {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}
+        #      with three retrieved documents (D1, D2, D3) and binary relevance
+        #      judgements (1 for relevant, 0 for not relevant):
+        #
+        #       Retrieved:  [D3 (0), D1 (1), D2 (1)]
+        #       Ideal:      [D1 (1), D2 (1), D3 (0)]
+        #
+        #       Calculate NDCG@3 for each
+        #       {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}:
+        #        * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
+        #        * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
+        #        * NDCG@3: 1.13/1.63 = 0.693
+        # @!attribute [rw] page_recall
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics::TopkMetrics]
+        #     Recall per page, at various top-k cutoff levels.
+        #
+        #     Recall is the fraction of relevant pages retrieved out of all relevant
+        #     pages.
+        #
+        #     Example (top-5):
+        #      * For a single
+        #      {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, if 3 out
+        #      of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+        # @!attribute [rw] page_ndcg
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics::TopkMetrics]
+        #     Normalized discounted cumulative gain (NDCG) per page, at various top-k
+        #     cutoff levels.
+        #
+        #     NDCG measures the ranking quality, giving higher relevance to top
+        #     results.
+        #
+        #     Example (top-3):
+        #      Suppose {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}
+        #      with three retrieved pages (P1, P2, P3) and binary relevance judgements (1
+        #      for relevant, 0 for not relevant):
+        #
+        #       Retrieved:  [P3 (0), P1 (1), P2 (1)]
+        #       Ideal:      [P1 (1), P2 (1), P3 (0)]
+        #
+        #       Calculate NDCG@3 for
+        #       {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}:
+        #        * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13
+        #        * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63
+        #        * NDCG@3: 1.13/1.63 = 0.693
+        class QualityMetrics
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Stores the metric values at specific top-k levels.
+          # @!attribute [rw] top_1
+          #   @return [::Float]
+          #     The top-1 value.
+          # @!attribute [rw] top_3
+          #   @return [::Float]
+          #     The top-3 value.
+          # @!attribute [rw] top_5
+          #   @return [::Float]
+          #     The top-5 value.
+          # @!attribute [rw] top_10
+          #   @return [::Float]
+          #     The top-10 value.
+          class TopkMetrics
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,194 @@
+# 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::EvaluationService::Client#get_evaluation EvaluationService.GetEvaluation}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}, such as
+        #     `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+        #
+        #     If the caller does not have permission to access the
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}, regardless of
+        #     whether or not it exists, a PERMISSION_DENIED error is returned.
+        #
+        #     If the requested
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation} does not
+        #     exist, a NOT_FOUND error is returned.
+        class GetEvaluationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent location resource name, such as
+        #     `projects/{project}/locations/{location}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}s under this
+        #     location, regardless of whether or not this location exists, a
+        #     `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}s to return. If
+        #     unspecified, defaults to 100. The maximum allowed value is 1000. Values
+        #     above 1000 will be coerced to 1000.
+        #
+        #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationsResponse#next_page_token ListEvaluationsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}
+        #     must match the call that provided the page token. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class ListEvaluationsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluations EvaluationService.ListEvaluations}
+        # method.
+        # @!attribute [rw] evaluations
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Evaluation>]
+        #     The {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationsRequest#page_token ListEvaluationsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListEvaluationsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#create_evaluation EvaluationService.CreateEvaluation}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource name, such as
+        #     `projects/{project}/locations/{location}`.
+        # @!attribute [rw] evaluation
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Evaluation]
+        #     Required. The {::Google::Cloud::DiscoveryEngine::V1beta::Evaluation Evaluation}
+        #     to create.
+        class CreateEvaluationRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#create_evaluation EvaluationService.CreateEvaluation}
+        # method.
+        class CreateEvaluationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}
+        # method.
+        # @!attribute [rw] evaluation
+        #   @return [::String]
+        #     Required. The evaluation resource name, such as
+        #     `projects/{project}/locations/{location}/evaluations/{evaluation}`.
+        #
+        #     If the caller does not have permission to list [EvaluationResult][]
+        #     under this evaluation, regardless of whether or not this evaluation
+        #     set exists, a `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Maximum number of [EvaluationResult][] to return. If unspecified,
+        #     defaults to 100. The maximum allowed value is 1000. Values above 1000 will
+        #     be coerced to 1000.
+        #
+        #     If this field is negative, an `INVALID_ARGUMENT` error is returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     A page token
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsResponse#next_page_token ListEvaluationResultsResponse.next_page_token},
+        #     received from a previous
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}
+        #     call. Provide this to retrieve the subsequent page.
+        #
+        #     When paginating, all other parameters provided to
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}
+        #     must match the call that provided the page token. Otherwise, an
+        #     `INVALID_ARGUMENT` error is returned.
+        class ListEvaluationResultsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::EvaluationService::Client#list_evaluation_results EvaluationService.ListEvaluationResults}
+        # method.
+        # @!attribute [rw] evaluation_results
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsResponse::EvaluationResult>]
+        #     The
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsResponse::EvaluationResult EvaluationResult}s.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token that can be sent as
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::ListEvaluationResultsRequest#page_token ListEvaluationResultsRequest.page_token}
+        #     to retrieve the next page. If this field is omitted, there are no
+        #     subsequent pages.
+        class ListEvaluationResultsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Represents the results of an evaluation for a single
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}.
+          # @!attribute [r] sample_query
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
+          #     Output only. The
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} that was
+          #     evaluated.
+          # @!attribute [r] quality_metrics
+          #   @return [::Google::Cloud::DiscoveryEngine::V1beta::QualityMetrics]
+          #     Output only. The metrics produced by the evaluation, for a given
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}.
+          class EvaluationResult
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -43,7 +43,7 @@ module Google
         #     `projects/*/locations/global/groundingConfigs/default_grounding_config`.
         # @!attribute [rw] answer_candidate
         #   @return [::String]
-        #     Answer candidate to check.
+        #     Answer candidate to check. Can have a maximum length of 1024 characters.
         # @!attribute [rw] facts
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>]
         #     List of facts for the grounding check.
@@ -51,9 +51,37 @@ module Google
         # @!attribute [rw] grounding_spec
         #   @return [::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingSpec]
         #     Configuration of the grounding check.
+        # @!attribute [rw] user_labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     The user labels applied to a resource must meet the following requirements:
+        #
+        #     * Each resource can have multiple labels, up to a maximum of 64.
+        #     * Each label must be a key-value pair.
+        #     * Keys have a minimum length of 1 character and a maximum length of 63
+        #       characters and cannot be empty. Values can be empty and have a maximum
+        #       length of 63 characters.
+        #     * Keys and values can contain only lowercase letters, numeric characters,
+        #       underscores, and dashes. All characters must use UTF-8 encoding, and
+        #       international characters are allowed.
+        #     * The key portion of a label must be unique. However, you can use the same
+        #       key with multiple resources.
+        #     * Keys must start with a lowercase letter or international character.
+        #
+        #     See [Google Cloud
+        #     Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
+        #     for more details.
         class CheckGroundingRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class UserLabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # Response message for the
@@ -95,6 +123,16 @@ module Google
           #     cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
           #     supporting for the claim. A citation to a fact indicates that the claim
           #     is supported by the fact.
+          # @!attribute [rw] grounding_check_required
+          #   @return [::Boolean]
+          #     Indicates that this claim required grounding check. When the system
+          #     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
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
+          #     and
+          #     [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
+          #     should not be returned.
           class Claim
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -54,6 +54,9 @@ module Google
         #     from the GroundingFacts provided in the request then this field will
         #     contain the index of the specific fact from which this chunk was
         #     retrieved.
+        # @!attribute [rw] index
+        #   @return [::Integer]
+        #     The index of this chunk. Currently, only used for the streaming mode.
         # @!attribute [rw] source_metadata
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     More fine-grained information for the source reference.

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

@@ -24,7 +24,7 @@ module Google
         # Cloud Storage location for input content.
         # @!attribute [rw] input_uris
         #   @return [::Array<::String>]
-        #     Required. Cloud Storage URIs to input files. URI can be up to
+        #     Required. Cloud Storage URIs to input files. Each URI can be up to
         #     2000 characters long. URIs can match the full object path (for example,
         #     `gs://bucket/directory/object.json`) or a pattern matching one or more
         #     files, such as `gs://bucket/directory/*.json`.
@@ -54,7 +54,7 @@ module Google
         #       data store. Each entry after the header is imported as a Document.
         #       This can only be used by the GENERIC Data Store vertical.
         #
-        #     Supported values for user even imports:
+        #     Supported values for user event imports:
         #
         #     * `user_event` (default): One JSON
         #     {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} per line.
@@ -351,8 +351,8 @@ module Google
         #     of 256 characters.
         # @!attribute [rw] collection_id
         #   @return [::String]
-        #     Required. The Firestore collection to copy the data from with a length
-        #     limit of 1,500 characters.
+        #     Required. The Firestore collection (or entity) to copy the data from with a
+        #     length limit of 1,500 characters.
         # @!attribute [rw] gcs_staging_dir
         #   @return [::String]
         #     Intermediate Cloud Storage directory used for the import with a length
@@ -690,6 +690,91 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#import_sample_queries SampleQueryService.ImportSampleQueries}
+        # method.
+        # @!attribute [rw] inline_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportSampleQueriesRequest::InlineSource]
+        #     The Inline source for sample query entries.
+        # @!attribute [rw] gcs_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::GcsSource]
+        #     Cloud Storage location for the input content.
+        # @!attribute [rw] bigquery_source
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource]
+        #     BigQuery input source.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent sample query set resource name, such as
+        #     `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        #
+        #     If the caller does not have permission to list
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s under this
+        #     sample query set, regardless of whether or not this sample query set
+        #     exists, a `PERMISSION_DENIED` error is returned.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportSampleQueriesRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The inline source for
+          # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s.
+          # @!attribute [rw] sample_queries
+          #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery>]
+          #     Required. A list of
+          #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s to
+          #     import. Max of 1000 items.
+          class InlineSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # Response of the
+        # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#import_sample_queries SampleQueryService.ImportSampleQueries}
+        # method. If the long running operation is done, this message is returned by
+        # the google.longrunning.Operations.response field if the operation is
+        # successful.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        # @!attribute [rw] error_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
+        #     The desired location of errors incurred during the Import.
+        class ImportSampleQueriesResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the ImportSampleQueries
+        # operation. This will be returned by the google.longrunning.Operation.metadata
+        # field.
+        # @!attribute [rw] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     ImportSampleQueries operation create time.
+        # @!attribute [rw] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     ImportSampleQueries operation last update time. If the operation is done,
+        #     this is also the finish time.
+        # @!attribute [rw] success_count
+        #   @return [::Integer]
+        #     Count of {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s
+        #     successfully imported.
+        # @!attribute [rw] failure_count
+        #   @return [::Integer]
+        #     Count of {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s
+        #     that failed to be imported.
+        # @!attribute [rw] total_count
+        #   @return [::Integer]
+        #     Total count of
+        #     {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s that were
+        #     processed.
+        class ImportSampleQueriesMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end