google-cloud-discovery_engine-v1 0.7.0 → 0.9.0

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

@@ -0,0 +1,106 @@
+# 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
+        # Metadata and configurations for a Google Cloud project in the service.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Full resource name of the project, for example
+        #     `projects/{project_number}`.
+        #     Note that when making requests, project number and project id are both
+        #     acceptable, but the server will always respond in project number.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this project is created.
+        # @!attribute [r] provision_completion_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this project is successfully provisioned.
+        #     Empty value means this project is still provisioning and is not ready for
+        #     use.
+        # @!attribute [r] service_terms_map
+        #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms}]
+        #     Output only. A map of terms of services. The key is the `id` of
+        #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms ServiceTerms}.
+        class Project
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Metadata about the terms of service.
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     The unique identifier of this terms of service.
+          #     Available terms:
+          #
+          #     * `GA_DATA_USE_TERMS`: [Terms for data
+          #     use](https://cloud.google.com/retail/data-use-terms). When using this as
+          #     `id`, the acceptable
+          #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#version version}
+          #     to provide is `2022-11-23`.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     The version string of the terms of service.
+          #     For acceptable values, see the comments for
+          #     {::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms#id id} above.
+          # @!attribute [rw] state
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms::State]
+          #     Whether the project has accepted/rejected the service terms or it is
+          #     still pending.
+          # @!attribute [rw] accept_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The last time when the project agreed to the terms of service.
+          # @!attribute [rw] decline_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     The last time when the project declined or revoked the agreement to terms
+          #     of service.
+          class ServiceTerms
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The agreement states this terms of service.
+            module State
+              # The default value of the enum. This value is not actually used.
+              STATE_UNSPECIFIED = 0
+
+              # The project has given consent to the terms of service.
+              TERMS_ACCEPTED = 1
+
+              # The project is pending to review and accept the terms of service.
+              TERMS_PENDING = 2
+
+              # The project has declined or revoked the agreement to terms of service.
+              TERMS_DECLINED = 3
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::Google::Cloud::DiscoveryEngine::V1::Project::ServiceTerms]
+          class ServiceTermsMapEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# 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 for
+        # {::Google::Cloud::DiscoveryEngine::V1::ProjectService::Client#provision_project ProjectService.ProvisionProject}
+        # method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. Full resource name of a
+        #     {::Google::Cloud::DiscoveryEngine::V1::Project Project}, such as
+        #     `projects/{project_id_or_number}`.
+        # @!attribute [rw] accept_data_use_terms
+        #   @return [::Boolean]
+        #     Required. Set to `true` to specify that caller has read and would like to
+        #     give consent to the [Terms for data
+        #     use](https://cloud.google.com/retail/data-use-terms).
+        # @!attribute [rw] data_use_terms_version
+        #   @return [::String]
+        #     Required. The version of the [Terms for data
+        #     use](https://cloud.google.com/retail/data-use-terms) that caller has read
+        #     and would like to give consent to.
+        #
+        #     Acceptable version is `2022-11-23`, and this may change over time.
+        class ProvisionProjectRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata associated with a project provision operation.
+        class ProvisionProjectMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -122,6 +122,48 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent data store resource name for which to purge completion
+        #     suggestions. Follows pattern
+        #     projects/*/locations/*/collections/*/dataStores/*.
+        class PurgeCompletionSuggestionsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_completion_suggestions CompletionService.PurgeCompletionSuggestions}
+        # method.
+        # @!attribute [rw] purge_succeeded
+        #   @return [::Boolean]
+        #     Whether the completion suggestions were successfully purged.
+        # @!attribute [rw] error_samples
+        #   @return [::Array<::Google::Rpc::Status>]
+        #     A sample of errors encountered while processing the request.
+        class PurgeCompletionSuggestionsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Metadata related to the progress of the PurgeCompletionSuggestions
+        # 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 PurgeCompletionSuggestionsMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -0,0 +1,124 @@
+# 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
+        # Record message for
+        # {::Google::Cloud::DiscoveryEngine::V1::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::V1::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::RankingRecord#title title} or
+        #     {::Google::Cloud::DiscoveryEngine::V1::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::V1::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::V1::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.
+        # @!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 RankRequest
+          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
+        # {::Google::Cloud::DiscoveryEngine::V1::RankService::Client#rank RankService.Rank} method.
+        # @!attribute [rw] records
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::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/v1/recommendation_service.rb

@@ -29,7 +29,7 @@ module Google
         #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
         #
         #     One default serving config is created along with your recommendation engine
-        #     creation. The engine ID will be used as the ID of the default serving
+        #     creation. The engine ID is used as the ID of the default serving
         #     config. For example, for Engine
         #     `projects/*/locations/global/collections/*/engines/my-engine`, you can use
         #     `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
@@ -57,9 +57,9 @@ module Google
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Maximum number of results to return. Set this property
-        #     to the number of recommendation results needed. If zero, the service will
-        #     choose a reasonable default. The maximum allowed value is 100. Values
-        #     above 100 will be coerced to 100.
+        #     to the number of recommendation results needed. If zero, the service
+        #     chooses a reasonable default. The maximum allowed value is 100. Values
+        #     above 100 are set to 100.
         # @!attribute [rw] filter
         #   @return [::String]
         #     Filter for restricting recommendation results with a length limit of 5,000
@@ -80,19 +80,19 @@ module Google
         #      * (available: true) AND
         #        (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
         #
-        #     If your filter blocks all results, the API will return generic
+        #     If your filter blocks all results, the API returns generic
         #     (unfiltered) popular Documents. If you only want results strictly matching
-        #     the filters, set `strictFiltering` to True in
+        #     the filters, set `strictFiltering` to `true` in
         #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}
         #     to receive empty results instead.
         #
-        #     Note that the API will never return
+        #     Note that the API never returns
         #     {::Google::Cloud::DiscoveryEngine::V1::Document Document}s with `storageStatus`
-        #     of `EXPIRED` or `DELETED` regardless of filter choices.
+        #     as `EXPIRED` or `DELETED` regardless of filter choices.
         # @!attribute [rw] validate_only
         #   @return [::Boolean]
-        #     Use validate only mode for this recommendation query. If set to true, a
-        #     fake model will be used that returns arbitrary Document IDs.
+        #     Use validate only mode for this recommendation query. If set to `true`, a
+        #     fake model is used that returns arbitrary Document IDs.
         #     Note that the validate only mode should only be used for testing the API,
         #     or if the model is not ready.
         # @!attribute [rw] params
@@ -101,16 +101,17 @@ module Google
         #
         #     Allowed values:
         #
-        #     * `returnDocument`: Boolean. If set to true, the associated Document
-        #        object will be returned in
+        #     * `returnDocument`: Boolean. If set to `true`, the associated Document
+        #        object is returned in
         #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
-        #     * `returnScore`: Boolean. If set to true, the recommendation 'score'
-        #        corresponding to each returned Document will be set in
+        #     * `returnScore`: Boolean. If set to true, the recommendation score
+        #        corresponding to each returned Document is set in
         #        {::Google::Cloud::DiscoveryEngine::V1::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
-        #        The given 'score' indicates the probability of a Document conversion
-        #        given the user's context and history.
-        #     * `strictFiltering`: Boolean. True by default. If set to false, the service
-        #        will return generic (unfiltered) popular Documents instead of empty if
+        #        The given score indicates the probability of a Document conversion given
+        #        the user's context and history.
+        #     * `strictFiltering`: Boolean. True by default. If set to `false`, the
+        #     service
+        #        returns generic (unfiltered) popular Documents instead of empty if
         #        your filter blocks all recommendation results.
         #     * `diversityLevel`: String. Default empty. If set to be non-empty, then
         #        it needs to be one of:
@@ -201,7 +202,7 @@ module Google
           #     {::Google::Cloud::DiscoveryEngine::V1::RecommendRequest#params RecommendRequest.params}.
           # @!attribute [rw] metadata
           #   @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
-          #     Additional Document metadata / annotations.
+          #     Additional Document metadata or annotations.
           #
           #     Possible values:
           #

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

@@ -46,9 +46,9 @@ module Google
         #     return. The service may return fewer than this value.
         #
         #     If unspecified, at most 100
-        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}s will be returned.
+        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}s are returned.
         #
-        #     The maximum value is 1000; values above 1000 will be coerced to 1000.
+        #     The maximum value is 1000; values above 1000 are set to 1000.
         # @!attribute [rw] page_token
         #   @return [::String]
         #     A page token, received from a previous
@@ -93,8 +93,8 @@ module Google
         # @!attribute [rw] schema_id
         #   @return [::String]
         #     Required. The ID to use for the
-        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}, which will become the
-        #     final component of the
+        #     {::Google::Cloud::DiscoveryEngine::V1::Schema Schema}, which becomes the final
+        #     component of the
         #     {::Google::Cloud::DiscoveryEngine::V1::Schema#name Schema.name}.
         #
         #     This field should conform to
@@ -114,7 +114,7 @@ module Google
         # @!attribute [rw] allow_missing
         #   @return [::Boolean]
         #     If set to true, and the {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} is
-        #     not found, a new {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} will be
+        #     not found, a new {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} is
         #     created. In this situation, `update_mask` is ignored.
         class UpdateSchemaRequest
           include ::Google::Protobuf::MessageExts