google-cloud-discovery_engine-v1beta 0.14.2 → 0.16.0

data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb

@@ -327,6 +327,44 @@ module Google
                 result
               end
 
+              ##
+              # Baseline implementation for the batch_get_documents_metadata REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest]
+              #   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::V1beta::BatchGetDocumentsMetadataResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataResponse]
+              #   A result object deserialized from the server's reply
+              def batch_get_documents_metadata request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_batch_get_documents_metadata_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::V1beta::BatchGetDocumentsMetadataResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
               ##
               # @private
               #
@@ -530,6 +568,34 @@ module Google
                                                         )
                 transcoder.transcode request_pb
               end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the batch_get_documents_metadata REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1beta::BatchGetDocumentsMetadataRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_batch_get_documents_metadata_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1beta/{parent}/batchGetDocumentsMetadata",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1beta/{parent}/batchGetDocumentsMetadata",
+                                                          matches: [
+                                                            ["parent", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
             end
           end
         end

data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb

@@ -714,7 +714,7 @@ module Google
             #   @param name [::String]
             #     Required. The name of the engine to pause.
             #     Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
@@ -804,7 +804,7 @@ module Google
             #   @param name [::String]
             #     Required. The name of the engine to resume.
             #     Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
@@ -894,7 +894,7 @@ module Google
             #   @param name [::String]
             #     Required. The resource name of the engine to tune.
             #     Format:
-            #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+            #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]

data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb

@@ -672,7 +672,7 @@ module Google
               #   @param name [::String]
               #     Required. The name of the engine to pause.
               #     Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -755,7 +755,7 @@ module Google
               #   @param name [::String]
               #     Required. The name of the engine to resume.
               #     Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::Engine]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -838,7 +838,7 @@ module Google
               #   @param name [::String]
               #     Required. The resource name of the engine to tune.
               #     Format:
-              #     `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
+              #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]

data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb

@@ -183,6 +183,206 @@ module Google
 
             # Service calls
 
+            ##
+            # Generates grounded content in a streaming fashion.
+            #
+            # @param request [::Gapic::StreamInput, ::Enumerable<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest, ::Hash>]
+            #   An enumerable of {::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest} instances.
+            # @param options [::Gapic::CallOptions, ::Hash]
+            #   Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/discovery_engine/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationService::Client.new
+            #
+            #   # Create an input stream.
+            #   input = Gapic::StreamInput.new
+            #
+            #   # Call the stream_generate_grounded_content method to start streaming.
+            #   output = client.stream_generate_grounded_content input
+            #
+            #   # Send requests on the stream. For each request object, set fields by
+            #   # passing keyword arguments. Be sure to close the stream when done.
+            #   input << Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest.new
+            #   input << Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest.new
+            #   input.close
+            #
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse
+            #   output.each do |current_response|
+            #     p current_response
+            #   end
+            #
+            def stream_generate_grounded_content request, options = nil
+              unless request.is_a? ::Enumerable
+                raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
+                request = request.to_enum
+              end
+
+              request = request.lazy.map do |req|
+                ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest
+              end
+
+              # 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
+              metadata = @config.rpcs.stream_generate_grounded_content.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              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::V1beta::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              options.apply_defaults timeout:      @config.rpcs.stream_generate_grounded_content.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.stream_generate_grounded_content.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @grounded_generation_service_stub.call_rpc :stream_generate_grounded_content, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
+            ##
+            # 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::V1beta::GenerateGroundedContentRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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.
+            #   @param generation_spec [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest::GenerationSpec, ::Hash]
+            #     Content generation specification.
+            #   @param grounding_spec [::Google::Cloud::DiscoveryEngine::V1beta::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 [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentResponse]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/discovery_engine/v1beta"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationService::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::DiscoveryEngine::V1beta::GenerateGroundedContentRequest.new
+            #
+            #   # Call the generate_grounded_content method.
+            #   result = client.generate_grounded_content request
+            #
+            #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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
+              metadata = @config.rpcs.generate_grounded_content.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              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::V1beta::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.location
+                header_params["location"] = request.location
+              end
+
+              request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.generate_grounded_content.timeout,
+                                     metadata:     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.call_rpc :generate_grounded_content, request, options: options do |response, operation|
+                yield response, operation if block_given?
+                return response
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Performs a grounding check.
             #
@@ -205,7 +405,7 @@ module Google
             #     Required. The resource name of the grounding config, such as
             #     `projects/*/locations/global/groundingConfigs/default_grounding_config`.
             #   @param answer_candidate [::String]
-            #     Answer candidate to check. Can have a maximum length of 1024 characters.
+            #     Answer candidate to check. It can have a maximum length of 4096 tokens.
             #   @param facts [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact, ::Hash>]
             #     List of facts for the grounding check.
             #     We support up to 200 facts.
@@ -311,17 +511,17 @@ module Google
             # @example
             #
             #   # Modify the global config, setting the timeout for
-            #   # check_grounding to 20 seconds,
+            #   # stream_generate_grounded_content to 20 seconds,
             #   # and all remaining timeouts to 10 seconds.
             #   ::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationService::Client.configure do |config|
             #     config.timeout = 10.0
-            #     config.rpcs.check_grounding.timeout = 20.0
+            #     config.rpcs.stream_generate_grounded_content.timeout = 20.0
             #   end
             #
             #   # Apply the above configuration only to a new client.
             #   client = ::Google::Cloud::DiscoveryEngine::V1beta::GroundedGenerationService::Client.new do |config|
             #     config.timeout = 10.0
-            #     config.rpcs.check_grounding.timeout = 20.0
+            #     config.rpcs.stream_generate_grounded_content.timeout = 20.0
             #   end
             #
             # @!attribute [rw] endpoint
@@ -448,6 +648,16 @@ module Google
               #         trigger a retry.
               #
               class Rpcs
+                ##
+                # RPC-specific configuration for `stream_generate_grounded_content`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :stream_generate_grounded_content
+                ##
+                # 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]
@@ -456,6 +666,10 @@ module Google
 
                 # @private
                 def initialize parent_rpcs = nil
+                  stream_generate_grounded_content_config = parent_rpcs.stream_generate_grounded_content if parent_rpcs.respond_to? :stream_generate_grounded_content
+                  @stream_generate_grounded_content = ::Gapic::Config::Method.new stream_generate_grounded_content_config
+                  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/v1beta/grounded_generation_service/paths.rb

@@ -43,6 +43,91 @@ module Google
               "projects/#{project}/locations/#{location}/groundingConfigs/#{grounding_config}"
             end
 
+            ##
+            # Create a fully-qualified Location resource string.
+            #
+            # The resource will be in the following format:
+            #
+            # `projects/{project}/locations/{location}`
+            #
+            # @param project [String]
+            # @param location [String]
+            #
+            # @return [::String]
+            def location_path project:, location:
+              raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+
+              "projects/#{project}/locations/#{location}"
+            end
+
+            ##
+            # Create a fully-qualified ServingConfig resource string.
+            #
+            # @overload serving_config_path(project:, location:, data_store:, serving_config:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param data_store [String]
+            #   @param serving_config [String]
+            #
+            # @overload serving_config_path(project:, location:, collection:, data_store:, serving_config:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param data_store [String]
+            #   @param serving_config [String]
+            #
+            # @overload serving_config_path(project:, location:, collection:, engine:, serving_config:)
+            #   The resource will be in the following format:
+            #
+            #   `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}`
+            #
+            #   @param project [String]
+            #   @param location [String]
+            #   @param collection [String]
+            #   @param engine [String]
+            #   @param serving_config [String]
+            #
+            # @return [::String]
+            def serving_config_path **args
+              resources = {
+                "data_store:location:project:serving_config" => (proc do |project:, location:, data_store:, serving_config:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/dataStores/#{data_store}/servingConfigs/#{serving_config}"
+                end),
+                "collection:data_store:location:project:serving_config" => (proc do |project:, location:, collection:, data_store:, serving_config:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+                  raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/servingConfigs/#{serving_config}"
+                end),
+                "collection:engine:location:project:serving_config" => (proc do |project:, location:, collection:, engine:, serving_config:|
+                  raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
+                  raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
+                  raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
+                  raise ::ArgumentError, "engine cannot contain /" if engine.to_s.include? "/"
+
+                  "projects/#{project}/locations/#{location}/collections/#{collection}/engines/#{engine}/servingConfigs/#{serving_config}"
+                end)
+              }
+
+              resource = resources[args.keys.sort.join(":")]
+              raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
+              resource.call(**args)
+            end
+
             extend self
           end
         end