google-apis-discoveryengine_v1beta 0.51.0 → 0.53.0

data/lib/google/apis/discoveryengine_v1beta/service.rb

@@ -2173,6 +2173,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Answer query method (streaming). It takes one AnswerQueryRequest and returns
+        # multiple AnswerQueryResponse messages in a stream.
+        # @param [String] serving_config
+        #   Required. The resource name of the Search serving config, such as `projects/*/
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/*/servingConfigs/default_serving_config`. This
+        #   field is used to identify the serving configuration name, set of models used
+        #   to make the search.
+        # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def stream_project_location_collection_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+servingConfig}:streamAnswer', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
         # error is returned.
         # @param [String] parent
@@ -2246,6 +2285,9 @@ module Google
         #   Required. The resource name of the Session to get. Format: `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store_id`/
         #   sessions/`session_id``
+        # @param [Boolean] include_answer_details
+        #   Optional. If set to true, the full session including all answer details will
+        #   be returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -2263,11 +2305,12 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def get_project_location_collection_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
+        def get_project_location_collection_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1beta/{+name}', options)
           command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
           command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
           command.params['name'] = name unless name.nil?
+          command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
@@ -2283,7 +2326,9 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` Example: "update_time desc" "create_time"
+        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
+        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max
         #   allowed value is 1000.
@@ -3082,8 +3127,12 @@ module Google
         # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
         # Users should not call this method directly.
         # @param [String] parent
-        #   Required. The parent DataStore resource name, such as `projects/`project`/
-        #   locations/`location`/collections/`collection`/dataStores/`data_store``.
+        #   Required. The parent resource name. If the collect user event action is
+        #   applied in DataStore level, the format is: `projects/`project`/locations/`
+        #   location`/collections/`collection`/dataStores/`data_store``. If the collect
+        #   user event action is applied in Location level, for example, the event with
+        #   Document across multiple DataStore, the format is: `projects/`project`/
+        #   locations/`location``.
         # @param [Fixnum] ets
         #   The event timestamp in milliseconds. This prevents browser caching of
         #   otherwise identical get requests. The name is abbreviated to reduce the
@@ -4337,6 +4386,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Answer query method (streaming). It takes one AnswerQueryRequest and returns
+        # multiple AnswerQueryResponse messages in a stream.
+        # @param [String] serving_config
+        #   Required. The resource name of the Search serving config, such as `projects/*/
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/*/servingConfigs/default_serving_config`. This
+        #   field is used to identify the serving configuration name, set of models used
+        #   to make the search.
+        # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def stream_project_location_collection_engine_serving_config_answer(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+servingConfig}:streamAnswer', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
         # error is returned.
         # @param [String] parent
@@ -4410,6 +4498,9 @@ module Google
         #   Required. The resource name of the Session to get. Format: `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store_id`/
         #   sessions/`session_id``
+        # @param [Boolean] include_answer_details
+        #   Optional. If set to true, the full session including all answer details will
+        #   be returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -4427,11 +4518,12 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def get_project_location_collection_engine_session(name, fields: nil, quota_user: nil, options: nil, &block)
+        def get_project_location_collection_engine_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1beta/{+name}', options)
           command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
           command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
           command.params['name'] = name unless name.nil?
+          command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
@@ -4447,7 +4539,9 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` Example: "update_time desc" "create_time"
+        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
+        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max
         #   allowed value is 1000.
@@ -6504,6 +6598,45 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Answer query method (streaming). It takes one AnswerQueryRequest and returns
+        # multiple AnswerQueryResponse messages in a stream.
+        # @param [String] serving_config
+        #   Required. The resource name of the Search serving config, such as `projects/*/
+        #   locations/global/collections/default_collection/engines/*/servingConfigs/
+        #   default_serving_config`, or `projects/*/locations/global/collections/
+        #   default_collection/dataStores/*/servingConfigs/default_serving_config`. This
+        #   field is used to identify the serving configuration name, set of models used
+        #   to make the search.
+        # @param [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest] google_cloud_discoveryengine_v1beta_answer_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def stream_project_location_data_store_serving_config_answer(serving_config, google_cloud_discoveryengine_v1beta_answer_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta/{+servingConfig}:streamAnswer', options)
+          command.request_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryRequest::Representation
+          command.request_object = google_cloud_discoveryengine_v1beta_answer_query_request_object
+          command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse::Representation
+          command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAnswerQueryResponse
+          command.params['servingConfig'] = serving_config unless serving_config.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Creates a Session. If the Session to create already exists, an ALREADY_EXISTS
         # error is returned.
         # @param [String] parent
@@ -6577,6 +6710,9 @@ module Google
         #   Required. The resource name of the Session to get. Format: `projects/`project`/
         #   locations/`location`/collections/`collection`/dataStores/`data_store_id`/
         #   sessions/`session_id``
+        # @param [Boolean] include_answer_details
+        #   Optional. If set to true, the full session including all answer details will
+        #   be returned.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -6594,11 +6730,12 @@ module Google
         # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
         # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
         # @raise [Google::Apis::AuthorizationError] Authorization is required
-        def get_project_location_data_store_session(name, fields: nil, quota_user: nil, options: nil, &block)
+        def get_project_location_data_store_session(name, include_answer_details: nil, fields: nil, quota_user: nil, options: nil, &block)
           command = make_simple_command(:get, 'v1beta/{+name}', options)
           command.response_representation = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession::Representation
           command.response_class = Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaSession
           command.params['name'] = name unless name.nil?
+          command.query['includeAnswerDetails'] = include_answer_details unless include_answer_details.nil?
           command.query['fields'] = fields unless fields.nil?
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
@@ -6614,7 +6751,9 @@ module Google
         # @param [String] order_by
         #   A comma-separated list of fields to order by, sorted in ascending order. Use "
         #   desc" after a field name for descending. Supported fields: * `update_time` * `
-        #   create_time` * `session_name` Example: "update_time desc" "create_time"
+        #   create_time` * `session_name` * `is_pinned` Example: * "update_time desc" * "
+        #   create_time" * "is_pinned desc,update_time desc": list sessions by is_pinned
+        #   first, then by update_time.
         # @param [Fixnum] page_size
         #   Maximum number of results to return. If unspecified, defaults to 50. Max
         #   allowed value is 1000.
@@ -7224,8 +7363,12 @@ module Google
         # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
         # Users should not call this method directly.
         # @param [String] parent
-        #   Required. The parent DataStore resource name, such as `projects/`project`/
-        #   locations/`location`/collections/`collection`/dataStores/`data_store``.
+        #   Required. The parent resource name. If the collect user event action is
+        #   applied in DataStore level, the format is: `projects/`project`/locations/`
+        #   location`/collections/`collection`/dataStores/`data_store``. If the collect
+        #   user event action is applied in Location level, for example, the event with
+        #   Document across multiple DataStore, the format is: `projects/`project`/
+        #   locations/`location``.
         # @param [Fixnum] ets
         #   The event timestamp in milliseconds. This prevents browser caching of
         #   otherwise identical get requests. The name is abbreviated to reduce the
@@ -8257,8 +8400,12 @@ module Google
         # only by the Discovery Engine API JavaScript pixel and Google Tag Manager.
         # Users should not call this method directly.
         # @param [String] parent
-        #   Required. The parent DataStore resource name, such as `projects/`project`/
-        #   locations/`location`/collections/`collection`/dataStores/`data_store``.
+        #   Required. The parent resource name. If the collect user event action is
+        #   applied in DataStore level, the format is: `projects/`project`/locations/`
+        #   location`/collections/`collection`/dataStores/`data_store``. If the collect
+        #   user event action is applied in Location level, for example, the event with
+        #   Document across multiple DataStore, the format is: `projects/`project`/
+        #   locations/`location``.
         # @param [Fixnum] ets
         #   The event timestamp in milliseconds. This prevents browser caching of
         #   otherwise identical get requests. The name is abbreviated to reduce the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-discoveryengine_v1beta
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.51.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1beta/v0.53.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1beta
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Discovery Engine API V1beta