google-cloud-discovery_engine-v1 1.0.2 → 1.2.0

data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/client.rb

@@ -176,6 +176,122 @@ module Google
 
               # Service calls
 
+              ##
+              # Generates grounded content.
+              #
+              # @overload generate_grounded_content(request, options = nil)
+              #   Pass arguments to `generate_grounded_content` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload generate_grounded_content(location: nil, system_instruction: nil, contents: nil, generation_spec: nil, grounding_spec: nil, user_labels: nil)
+              #   Pass arguments to `generate_grounded_content` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param location [::String]
+              #     Required. Location resource.
+              #
+              #     Format: `projects/{project}/locations/{location}`.
+              #   @param system_instruction [::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent, ::Hash]
+              #     Content of the system instruction for the current API.
+              #
+              #     These instructions will take priority over any other prompt instructions
+              #     if the selected model is supporting them.
+              #   @param contents [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationContent, ::Hash>]
+              #     Content of the current conversation with the model.
+              #
+              #     For single-turn queries, this is a single instance. For multi-turn queries,
+              #     this is a repeated field that contains conversation history + latest
+              #     request.
+              #
+              #     Only a single-turn query is supported currently.
+              #   @param generation_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GenerationSpec, ::Hash]
+              #     Content generation specification.
+              #   @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSpec, ::Hash]
+              #     Grounding specification.
+              #   @param user_labels [::Hash{::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.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/discovery_engine/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest.new
+              #
+              #   # Call the generate_grounded_content method.
+              #   result = client.generate_grounded_content request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse.
+              #   p result
+              #
+              def generate_grounded_content request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.generate_grounded_content.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::DiscoveryEngine::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.generate_grounded_content.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.generate_grounded_content.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @grounded_generation_service_stub.generate_grounded_content request, options do |result, operation|
+                  yield result, operation if block_given?
+                  return result
+                end
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Performs a grounding check.
               #
@@ -297,17 +413,17 @@ module Google
               # @example
               #
               #   # Modify the global config, setting the timeout for
-              #   # check_grounding to 20 seconds,
+              #   # generate_grounded_content to 20 seconds,
               #   # and all remaining timeouts to 10 seconds.
               #   ::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Rest::Client.configure do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.check_grounding.timeout = 20.0
+              #     config.rpcs.generate_grounded_content.timeout = 20.0
               #   end
               #
               #   # Apply the above configuration only to a new client.
               #   client = ::Google::Cloud::DiscoveryEngine::V1::GroundedGenerationService::Rest::Client.new do |config|
               #     config.timeout = 10.0
-              #     config.rpcs.check_grounding.timeout = 20.0
+              #     config.rpcs.generate_grounded_content.timeout = 20.0
               #   end
               #
               # @!attribute [rw] endpoint
@@ -414,6 +530,11 @@ module Google
                 #         trigger a retry.
                 #
                 class Rpcs
+                  ##
+                  # RPC-specific configuration for `generate_grounded_content`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :generate_grounded_content
                   ##
                   # RPC-specific configuration for `check_grounding`
                   # @return [::Gapic::Config::Method]
@@ -422,6 +543,8 @@ module Google
 
                   # @private
                   def initialize parent_rpcs = nil
+                    generate_grounded_content_config = parent_rpcs.generate_grounded_content if parent_rpcs.respond_to? :generate_grounded_content
+                    @generate_grounded_content = ::Gapic::Config::Method.new generate_grounded_content_config
                     check_grounding_config = parent_rpcs.check_grounding if parent_rpcs.respond_to? :check_grounding
                     @check_grounding = ::Gapic::Config::Method.new check_grounding_config
 

data/lib/google/cloud/discovery_engine/v1/grounded_generation_service/rest/service_stub.rb

@@ -61,6 +61,44 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # Baseline implementation for the generate_grounded_content REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse]
+              #   A result object deserialized from the server's reply
+              def generate_grounded_content request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_generate_grounded_content_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri:     uri,
+                  body:    body || "",
+                  params:  query_string_params,
+                  options: options
+                )
+                operation = ::Gapic::Rest::TransportOperation.new response
+                result = ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # Baseline implementation for the check_grounding REST call
               #
@@ -99,6 +137,28 @@ module Google
                 result
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the generate_grounded_content REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_generate_grounded_content_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{location}:generateGroundedContent",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["location", %r{^projects/[^/]+/locations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #

data/lib/google/cloud/discovery_engine/v1/project_service/rest/operations.rb

@@ -911,6 +911,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}/operations",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}/operations",
@@ -1030,6 +1037,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}",

data/lib/google/cloud/discovery_engine/v1/rank_service/client.rb

@@ -203,7 +203,7 @@ module Google
             #
             #   @param ranking_config [::String]
             #     Required. The resource name of the rank service config, such as
-            #     `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+            #     `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
             #   @param model [::String]
             #     The identifier of the model to use. It is one of:
             #

data/lib/google/cloud/discovery_engine/v1/rank_service/rest/client.rb

@@ -196,7 +196,7 @@ module Google
               #
               #   @param ranking_config [::String]
               #     Required. The resource name of the rank service config, such as
-              #     `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`.
+              #     `projects/{project_num}/locations/{location}/rankingConfigs/default_ranking_config`.
               #   @param model [::String]
               #     The identifier of the model to use. It is one of:
               #

data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb

@@ -202,7 +202,8 @@ module Google
             #   the default parameter values, pass an empty Hash as a request object (see above).
             #
             #   @param serving_config [::String]
-            #     Required. Full resource name of a [ServingConfig][]:
+            #     Required. Full resource name of a
+            #     [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]:
             #     `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
             #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
             #

data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb

@@ -195,7 +195,8 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param serving_config [::String]
-              #     Required. Full resource name of a [ServingConfig][]:
+              #     Required. Full resource name of a
+              #     [ServingConfig][google.cloud.discoveryengine.v1.ServingConfig]:
               #     `projects/*/locations/global/collections/*/engines/*/servingConfigs/*`, or
               #     `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
               #

data/lib/google/cloud/discovery_engine/v1/rest.rb

@@ -28,6 +28,7 @@ require "google/cloud/discovery_engine/v1/project_service/rest"
 require "google/cloud/discovery_engine/v1/rank_service/rest"
 require "google/cloud/discovery_engine/v1/recommendation_service/rest"
 require "google/cloud/discovery_engine/v1/schema_service/rest"
+require "google/cloud/discovery_engine/v1/search_tuning_service/rest"
 require "google/cloud/discovery_engine/v1/site_search_engine_service/rest"
 require "google/cloud/discovery_engine/v1/user_event_service/rest"
 require "google/cloud/discovery_engine/v1/version"

data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb

@@ -911,6 +911,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}/operations",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}/operations",
@@ -1030,6 +1037,13 @@ module Google
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+/?$}, false]
                                                           ]
                                                         )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{name}",
+                                                          matches: [
+                                                            ["name", %r{^projects/[^/]+/locations/[^/]+/identityMappingStores/[^/]+/operations/[^/]+/?$}, false]
+                                                          ]
+                                                        )
                                                         .with_bindings(
                                                           uri_method: :get,
                                                           uri_template: "/v1/{name}",

data/lib/google/cloud/discovery_engine/v1/search_service/client.rb

@@ -196,7 +196,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
+            # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
             #   Pass arguments to `search` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -246,6 +246,10 @@ module Google
             #     unset.
             #
             #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+            #   @param one_box_page_size [::Integer]
+            #     The maximum number of results to return for OneBox.
+            #     This applies to each OneBox type individually.
+            #     Default number is 10.
             #   @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
             #     Specs defining dataStores to filter on in a search call and configurations
             #     for those dataStores. This is only considered for engines with multiple
@@ -286,9 +290,12 @@ module Google
             #     Leave it unset if ordered by relevance. `order_by` expression is
             #     case-sensitive.
             #
-            #     For more information on ordering for retail search, see
-            #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
-            #
+            #     For more information on ordering the website search results, see
+            #     [Order web search
+            #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
+            #     For more information on ordering the healthcare search results, see
+            #     [Order healthcare search
+            #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
             #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
             #   @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
             #     Information about the end user.

data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb

@@ -189,7 +189,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
+              # @overload search(serving_config: nil, branch: nil, query: nil, image_query: nil, page_size: nil, page_token: nil, offset: nil, one_box_page_size: nil, data_store_specs: nil, filter: nil, canonical_filter: nil, order_by: nil, user_info: nil, language_code: nil, facet_specs: nil, boost_spec: nil, params: nil, query_expansion_spec: nil, spell_correction_spec: nil, user_pseudo_id: nil, content_search_spec: nil, safe_search: nil, user_labels: nil, search_as_you_type_spec: nil, session: nil, session_spec: nil)
               #   Pass arguments to `search` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -239,6 +239,10 @@ module Google
               #     unset.
               #
               #     If this field is negative, an  `INVALID_ARGUMENT`  is returned.
+              #   @param one_box_page_size [::Integer]
+              #     The maximum number of results to return for OneBox.
+              #     This applies to each OneBox type individually.
+              #     Default number is 10.
               #   @param data_store_specs [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::DataStoreSpec, ::Hash>]
               #     Specs defining dataStores to filter on in a search call and configurations
               #     for those dataStores. This is only considered for engines with multiple
@@ -279,9 +283,12 @@ module Google
               #     Leave it unset if ordered by relevance. `order_by` expression is
               #     case-sensitive.
               #
-              #     For more information on ordering for retail search, see
-              #     [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
-              #
+              #     For more information on ordering the website search results, see
+              #     [Order web search
+              #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results).
+              #     For more information on ordering the healthcare search results, see
+              #     [Order healthcare search
+              #     results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results).
               #     If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
               #   @param user_info [::Google::Cloud::DiscoveryEngine::V1::UserInfo, ::Hash]
               #     Information about the end user.