google-cloud-discovery_engine-v1 2.13.0 → 2.14.0

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

@@ -111,6 +111,12 @@ module Google
         #     stores. For engines with a single data store, the specs directly under
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} should be
         #     used.
+        #
+        #     On an engine with multiple data stores, this field is optional. If it's
+        #     empty, all of the engine's data stores are searched (blended search).
+        #     Unless it specifies exactly one data store, some request fields, such as
+        #     `order_by` and `query_expansion_spec`, aren't supported and return an
+        #     `INVALID_ARGUMENT` error.
         # @!attribute [rw] num_results_per_data_store
         #   @return [::Integer]
         #     Optional. The maximum number of results to retrieve from each data store.
@@ -446,7 +452,7 @@ module Google
         #     entities, domains, sites or regions, for example, "Google US", "Google
         #     Ads", "Waymo", "google.com", "youtube.com", etc. If this is set, it should
         #     be exactly matched with
-        #     [UserEvent.entity][google.cloud.discoveryengine.v1.UserEvent.entity] to get
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#entity UserEvent.entity} to get
         #     search results boosted by entity.
         class SearchRequest
           include ::Google::Protobuf::MessageExts

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

@@ -186,6 +186,9 @@ module Google
         #     Condition promote specifications.
         #
         #     Maximum number of specifications is 100.
+        # @!attribute [rw] answer_generation_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AnswerGenerationSpec]
+        #     Optional. The specification for answer generation.
         class ServingConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -255,6 +258,46 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
         end
+
+        # The specification for answer generation.
+        # @!attribute [rw] user_defined_classifier_spec
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::AnswerGenerationSpec::UserDefinedClassifierSpec]
+        #     Optional. The specification for user specified classifier spec.
+        class AnswerGenerationSpec
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The specification for user defined classifier.
+          # @!attribute [rw] enable_user_defined_classifier
+          #   @return [::Boolean]
+          #     Optional. Whether or not to enable and include user defined classifier.
+          # @!attribute [rw] preamble
+          #   @return [::String]
+          #     Optional. The preamble to be used for the user defined classifier.
+          # @!attribute [rw] model_id
+          #   @return [::String]
+          #     Optional. The model id to be used for the user defined classifier.
+          # @!attribute [rw] task_marker
+          #   @return [::String]
+          #     Optional. The task marker to be used for the user defined classifier.
+          # @!attribute [rw] top_p
+          #   @return [::Float]
+          #     Optional. The top-p value to be used for the user defined classifier.
+          # @!attribute [rw] top_k
+          #   @return [::Integer]
+          #     Optional. The top-k value to be used for the user defined classifier.
+          # @!attribute [rw] temperature
+          #   @return [::Float]
+          #     Optional. The temperature value to be used for the user defined
+          #     classifier.
+          # @!attribute [rw] seed
+          #   @return [::Integer]
+          #     Optional. The seed value to be used for the user defined classifier.
+          class UserDefinedClassifierSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

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

@@ -21,6 +21,26 @@ module Google
   module Cloud
     module DiscoveryEngine
       module V1
+        # Request for CreateServingConfig method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of parent. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+        # @!attribute [rw] serving_config
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::ServingConfig]
+        #     Required. The ServingConfig to create.
+        # @!attribute [rw] serving_config_id
+        #   @return [::String]
+        #     Required. The ID to use for the ServingConfig, which will become the final
+        #     component of the ServingConfig's resource name.
+        #
+        #     This value should be 4-63 characters, and valid characters
+        #     are /[a-zA-Z0-9][a-zA-Z0-9_-]+/.
+        class CreateServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request for UpdateServingConfig method.
         # @!attribute [rw] serving_config
         #   @return [::Google::Cloud::DiscoveryEngine::V1::ServingConfig]
@@ -38,6 +58,57 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Request for DeleteServingConfig method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ServingConfig to delete. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
+        class DeleteServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for GetServingConfig method.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The resource name of the ServingConfig to get. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config_id}`
+        class GetServingConfigRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request for ListServingConfigs method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. Full resource name of the parent resource. Format:
+        #     `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}`
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. Maximum number of results to return. If unspecified, defaults
+        #     to 100. If a value greater than 100 is provided, at most 100 results are
+        #     returned.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListServingConfigs` call.
+        #     Provide this to retrieve the subsequent page.
+        class ListServingConfigsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response for ListServingConfigs method.
+        # @!attribute [rw] serving_configs
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::ServingConfig>]
+        #     All the ServingConfigs for a given dataStore.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     Pagination token, if not returned indicates the last page.
+        class ListServingConfigsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -55,6 +55,12 @@ module Google
         #   @return [::Boolean]
         #     Optional. Whether the session is pinned, pinned session will be displayed
         #     on the top of the session list.
+        # @!attribute [r] pending_async_assist_operation_id
+        #   @return [::String]
+        #     Output only. Full resource name of an in-progress AsyncAssist operation for
+        #     this session, e.g.
+        #     `projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*`.
+        #     Set when the operation starts and cleared when it finishes.
         class Session
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -93,6 +99,9 @@ module Google
           #     LLM model and version used, model parameters (temperature, grounding
           #     parameters, etc.). The prefix "google." is reserved for Google-developed
           #     functionality.
+          # @!attribute [rw] live
+          #   @return [::Boolean]
+          #     Optional. Indicates whether this turn is a live turn.
           class Turn
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -34,7 +34,6 @@ module Google
         #     * `view-item-list`: View of a panel or ordered list of Documents.
         #     * `view-home-page`: View of the home page.
         #     * `view-category-page`: View of a category page, e.g. Home > Men > Jeans
-        #     * `add-feedback`: Add a user feedback.
         #
         #     Retail-related values:
         #
@@ -166,8 +165,9 @@ module Google
         #     to this field.
         # @!attribute [rw] filter
         #   @return [::String]
-        #     The filter syntax consists of an expression language for constructing a
-        #     predicate from one or more fields of the documents being filtered.
+        #     Optional. The filter syntax consists of an expression language for
+        #     constructing a predicate from one or more fields of the documents being
+        #     filtered.
         #
         #     One example is for `search` events, the associated
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest SearchRequest} may contain
@@ -233,7 +233,7 @@ module Google
         #     Currently, this field is restricted to at most one ID.
         # @!attribute [rw] attributes
         #   @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1::CustomAttribute}]
-        #     Extra user event features to include in the recommendation model.
+        #     Optional. Extra user event features to include in the recommendation model.
         #     These attributes must NOT contain data that needs to be parsed or processed
         #     further, e.g. JSON or other encodings.
         #
@@ -266,6 +266,16 @@ module Google
         #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::PanelInfo>]
         #     Optional. List of panels associated with this event.
         #     Used for page-level impression data.
+        # @!attribute [rw] feedback
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::Feedback]
+        #     Optional. This field is optional except for the `add-feedback` event types.
+        # @!attribute [rw] entity
+        #   @return [::String]
+        #     Optional. Represents the entity for customers that may run multiple
+        #     different entities, domains, sites or regions, for example, `Google US`,
+        #     `Google Ads`, `Waymo`, `google.com`, `youtube.com`, etc. We recommend that
+        #     you set `entity` to get better per-entity search, completion, and
+        #     prediction results.
         class UserEvent
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -329,7 +339,7 @@ module Google
         # Detailed search information.
         # @!attribute [rw] search_query
         #   @return [::String]
-        #     The user's search query.
+        #     Optional. The user's search query.
         #
         #     See
         #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#query SearchRequest.query}
@@ -378,7 +388,7 @@ module Google
         # clicked completion info.
         # @!attribute [rw] selected_suggestion
         #   @return [::String]
-        #     End user selected
+        #     Optional. End user selected
         #     {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse::QuerySuggestion#suggestion CompleteQueryResponse.QuerySuggestion.suggestion}.
         # @!attribute [rw] selected_position
         #   @return [::Integer]

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

@@ -34,7 +34,7 @@ module Google
         # @!attribute [r] license_assignment_state
         #   @return [::Google::Cloud::DiscoveryEngine::V1::UserLicense::LicenseAssignmentState]
         #     Output only. License assignment state of the user.
-        #     If the user is assigned with a license config, the user loggin will be
+        #     If the user is assigned with a license config, the user login will be
         #     assigned with the license;
         #     If the user's license assignment state is unassigned or unspecified, no
         #     license config will be associated to the user;
@@ -77,8 +77,23 @@ module Google
             # Users already logged in but cannot get license assigned will be assigned
             # NO_LICENSE state(License could be unassigned by admin).
             NO_LICENSE_ATTEMPTED_LOGIN = 4
+
+            # User is blocked from assigning a license.
+            BLOCKED = 5
           end
         end
+
+        # Stats about users' licenses.
+        # @!attribute [rw] license_config
+        #   @return [::String]
+        #     Required. The LicenseConfig name.
+        # @!attribute [rw] used_license_count
+        #   @return [::Integer]
+        #     Required. The number of licenses used.
+        class LicenseConfigUsageStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

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

@@ -25,13 +25,14 @@ module Google
         # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#list_user_licenses UserLicenseService.ListUserLicenses}.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent [UserStore][] resource name, format:
+        #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+        #     resource name, format:
         #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
         # @!attribute [rw] page_size
         #   @return [::Integer]
         #     Optional. Requested page size. Server may return fewer items than
-        #     requested. If unspecified, defaults to 10. The maximum value is 50; values
-        #     above 50 will be coerced to 50.
+        #     requested. If unspecified, defaults to 100. The maximum 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
@@ -48,7 +49,8 @@ module Google
         #     Supported fields:
         #
         #     * `license_assignment_state`
-        #
+        #     * `user_principal`
+        #     *
         #     Examples:
         #
         #     * `license_assignment_state = ASSIGNED` to list assigned user licenses.
@@ -57,6 +59,26 @@ module Google
         #     who attempted login but no license assigned.
         #     * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter
         #     out users who attempted login but no license assigned.
+        #     * `user_principal = user1@example.com` to list user license for
+        #     `user1@example.com`.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. The order in which the
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserLicense UserLicense}s are listed. The
+        #     value must be a comma-separated list of fields. Default sorting order is
+        #     ascending. To specify descending order for a field, append a " desc"
+        #     suffix. Redundant space characters in the syntax are insignificant.
+        #
+        #     Supported fields (only `user_principal` is supported for now):
+        #
+        #     * `user_principal`
+        #
+        #     If not set, the default ordering is by `user_principal`.
+        #
+        #     Examples:
+        #
+        #     * `user_principal` to order by `user_principal` in ascending order.
+        #     * `user_principal desc` to order by `user_principal` in descending order.
         class ListUserLicensesRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -77,15 +99,40 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#list_license_configs_usage_stats UserLicenseService.ListLicenseConfigsUsageStats}
+        # method.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent branch resource name, such as
+        #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
+        class ListLicenseConfigsUsageStatsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Response message for
+        # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#list_license_configs_usage_stats UserLicenseService.ListLicenseConfigsUsageStats}
+        # method.
+        # @!attribute [rw] license_config_usage_stats
+        #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::LicenseConfigUsageStats>]
+        #     All the customer's
+        #     {::Google::Cloud::DiscoveryEngine::V1::LicenseConfigUsageStats LicenseConfigUsageStats}.
+        class ListLicenseConfigsUsageStatsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::DiscoveryEngine::V1::UserLicenseService::Client#batch_update_user_licenses UserLicenseService.BatchUpdateUserLicenses}
         # method.
         # @!attribute [rw] inline_source
         #   @return [::Google::Cloud::DiscoveryEngine::V1::BatchUpdateUserLicensesRequest::InlineSource]
-        #     The inline source for the input content for document embeddings.
+        #     The inline source for the input content for license assignment.
         # @!attribute [rw] parent
         #   @return [::String]
-        #     Required. The parent [UserStore][] resource name, format:
+        #     Required. The parent {::Google::Cloud::DiscoveryEngine::V1::UserStore UserStore}
+        #     resource name, format:
         #     `projects/{project}/locations/{location}/userStores/{user_store_id}`.
         # @!attribute [rw] delete_unassigned_user_licenses
         #   @return [::Boolean]

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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
+        # Configures metadata that is used for End User entities.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Immutable. The full resource name of the User Store, in the format of
+        #     `projects/{project}/locations/{location}/userStores/{user_store}`.
+        #
+        #     This field must be a UTF-8 encoded string with a length limit of 1024
+        #     characters.
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     The display name of the User Store.
+        # @!attribute [rw] default_license_config
+        #   @return [::String]
+        #     Optional. The default subscription
+        #     {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig} for the
+        #     UserStore, if
+        #     {::Google::Cloud::DiscoveryEngine::V1::UserStore#enable_license_auto_register UserStore.enable_license_auto_register}
+        #     is true, new users will automatically register under the default
+        #     subscription.
+        #
+        #     If default {::Google::Cloud::DiscoveryEngine::V1::LicenseConfig LicenseConfig}
+        #     doesn't have remaining license seats left, new users will not be assigned
+        #     with license and will be blocked for Vertex AI Search features. This is
+        #     used if `license_assignment_tier_rules` is not configured.
+        # @!attribute [rw] enable_license_auto_register
+        #   @return [::Boolean]
+        #     Optional. Whether to enable license auto register for users in this User
+        #     Store. If true, new users will automatically register under the default
+        #     license config as long as the default license config has seats left.
+        # @!attribute [rw] enable_expired_license_auto_update
+        #   @return [::Boolean]
+        #     Optional. Whether to enable license auto update for users in this User
+        #     Store. If true, users with expired licenses will automatically be updated
+        #     to use the default license config as long as the default license config has
+        #     seats left.
+        class UserStore
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+# Copyright 2026 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::UserStoreService::Client#get_user_store UserStoreService.GetUserStore}
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the User Store to get.
+        #     Format:
+        #     `projects/{project}/locations/{location}/userStores/{user_store_id}`
+        class GetUserStoreRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for
+        # {::Google::Cloud::DiscoveryEngine::V1::UserStoreService::Client#update_user_store UserStoreService.UpdateUserStore}
+        # method.
+        # @!attribute [rw] user_store
+        #   @return [::Google::Cloud::DiscoveryEngine::V1::UserStore]
+        #     Required. The User Store to update.
+        #     Format:
+        #     `projects/{project}/locations/{location}/userStores/{user_store_id}`
+        # @!attribute [rw] update_mask
+        #   @return [::Google::Protobuf::FieldMask]
+        #     Optional. The list of fields to update.
+        class UpdateUserStoreRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end