google-cloud-discovery_engine-v1 0.a → 0.1.0

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

@@ -0,0 +1,388 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/cloud/errors"
+require "google/cloud/discoveryengine/v1/completion_service_pb"
+require "google/cloud/discovery_engine/v1/completion_service/rest/service_stub"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        module CompletionService
+          module Rest
+            ##
+            # REST client for the CompletionService service.
+            #
+            # Service for Auto-Completion.
+            #
+            class Client
+              include Paths
+
+              # @private
+              attr_reader :completion_service_stub
+
+              ##
+              # Configure the CompletionService Client class.
+              #
+              # See {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @example
+              #
+              #   # Modify the configuration for all CompletionService clients
+              #   ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def self.configure
+                @configure ||= begin
+                  namespace = ["Google", "Cloud", "DiscoveryEngine", "V1"]
+                  parent_config = while namespace.any?
+                                    parent_name = namespace.join "::"
+                                    parent_const = const_get parent_name
+                                    break parent_const.configure if parent_const.respond_to? :configure
+                                    namespace.pop
+                                  end
+                  default_config = Client::Configuration.new parent_config
+
+                  default_config.timeout = 5.0
+                  default_config.retry_policy = {
+                    initial_delay: 0.1, max_delay: 5.0, multiplier: 1.3, retry_codes: [14]
+                  }
+
+                  default_config
+                end
+                yield @configure if block_given?
+                @configure
+              end
+
+              ##
+              # Configure the CompletionService Client instance.
+              #
+              # The configuration is set to the derived mode, meaning that values can be changed,
+              # but structural changes (adding new fields, etc.) are not allowed. Structural changes
+              # should be made on {Client.configure}.
+              #
+              # See {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client::Configuration}
+              # for a description of the configuration fields.
+              #
+              # @yield [config] Configure the Client client.
+              # @yieldparam config [Client::Configuration]
+              #
+              # @return [Client::Configuration]
+              #
+              def configure
+                yield @config if block_given?
+                @config
+              end
+
+              ##
+              # Create a new CompletionService REST client object.
+              #
+              # @example
+              #
+              #   # Create a client using the default configuration
+              #   client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
+              #
+              #   # Create a client using a custom configuration
+              #   client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #   end
+              #
+              # @yield [config] Configure the CompletionService client.
+              # @yieldparam config [Client::Configuration]
+              #
+              def initialize
+                # Create the configuration object
+                @config = Configuration.new Client.configure
+
+                # Yield the configuration if needed
+                yield @config if block_given?
+
+                # Create credentials
+                credentials = @config.credentials
+                # Use self-signed JWT if the endpoint is unchanged from default,
+                # but only if the default endpoint does not have a region prefix.
+                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-")
+                credentials ||= Credentials.default scope: @config.scope,
+                                                    enable_self_signed_jwt: enable_self_signed_jwt
+                if credentials.is_a?(::String) || credentials.is_a?(::Hash)
+                  credentials = Credentials.new credentials, scope: @config.scope
+                end
+
+                @quota_project_id = @config.quota_project
+                @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
+
+                @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+              end
+
+              # Service calls
+
+              ##
+              # Completes the specified user input with keyword suggestions.
+              #
+              # @overload complete_query(request, options = nil)
+              #   Pass arguments to `complete_query` via a request object, either of type
+              #   {::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest, ::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 complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil)
+              #   Pass arguments to `complete_query` 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 data_store [::String]
+              #     Required. The parent data store resource name for which the completion is
+              #     performed, such as
+              #     `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
+              #   @param query [::String]
+              #     Required. The typeahead input used to fetch suggestions. Maximum length is
+              #     128 characters.
+              #   @param query_model [::String]
+              #     Selects data model of query suggestions for serving. Currently supported
+              #     values:
+              #
+              #     * `document` - Using suggestions generated from user-imported documents.
+              #     * `search-history` - Using suggestions generated from the past history of
+              #     {::Google::Cloud::DiscoveryEngine::V1::SearchService::Rest::Client#search SearchService.Search}
+              #     API calls. Do not use it when there is no traffic for Search API.
+              #     * `user-event` - Using suggestions generated from user-imported search
+              #     events.
+              #
+              #     Default values:
+              #
+              #     * `document` is the default model for regular dataStores.
+              #     * `search-history` is the default model for
+              #     [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH]
+              #     dataStores.
+              #   @param user_pseudo_id [::String]
+              #     A unique identifier for tracking visitors. For example, this could be
+              #     implemented with an HTTP cookie, which should be able to uniquely identify
+              #     a visitor on a single device. This unique identifier should not change if
+              #     the visitor logs in or out of the website.
+              #
+              #     This field should NOT have a fixed value such as `unknown_visitor`.
+              #
+              #     This should be the same identifier as
+              #     {::Google::Cloud::DiscoveryEngine::V1::UserEvent#user_pseudo_id UserEvent.user_pseudo_id}
+              #     and
+              #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#user_pseudo_id SearchRequest.user_pseudo_id}.
+              #
+              #     The field must be a UTF-8 encoded string with a length limit of 128
+              #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              # @yield [result, operation] Access the result along with the TransportOperation object
+              # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              def complete_query request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest
+
+                # 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.complete_query.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project 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-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.complete_query.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.complete_query.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @completion_service_stub.complete_query 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
+
+              ##
+              # Configuration class for the CompletionService REST API.
+              #
+              # This class represents the configuration for CompletionService REST,
+              # providing control over timeouts, retry behavior, logging, transport
+              # parameters, and other low-level controls. Certain parameters can also be
+              # applied individually to specific RPCs. See
+              # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client::Configuration::Rpcs}
+              # for a list of RPCs that can be configured independently.
+              #
+              # Configuration can be applied globally to all clients, or to a single client
+              # on construction.
+              #
+              # @example
+              #
+              #   # Modify the global config, setting the timeout for
+              #   # complete_query to 20 seconds,
+              #   # and all remaining timeouts to 10 seconds.
+              #   ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.configure do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.complete_query.timeout = 20.0
+              #   end
+              #
+              #   # Apply the above configuration only to a new client.
+              #   client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new do |config|
+              #     config.timeout = 10.0
+              #     config.rpcs.complete_query.timeout = 20.0
+              #   end
+              #
+              # @!attribute [rw] endpoint
+              #   The hostname or hostname:port of the service endpoint.
+              #   Defaults to `"discoveryengine.googleapis.com"`.
+              #   @return [::String]
+              # @!attribute [rw] credentials
+              #   Credentials to send with calls. You may provide any of the following types:
+              #    *  (`String`) The path to a service account key file in JSON format
+              #    *  (`Hash`) A service account key as a Hash
+              #    *  (`Google::Auth::Credentials`) A googleauth credentials object
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
+              #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
+              #    *  (`nil`) indicating no credentials
+              #   @return [::Object]
+              # @!attribute [rw] scope
+              #   The OAuth scopes
+              #   @return [::Array<::String>]
+              # @!attribute [rw] lib_name
+              #   The library name as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] lib_version
+              #   The library version as recorded in instrumentation and logging
+              #   @return [::String]
+              # @!attribute [rw] timeout
+              #   The call timeout in seconds.
+              #   @return [::Numeric]
+              # @!attribute [rw] metadata
+              #   Additional headers to be sent with the call.
+              #   @return [::Hash{::Symbol=>::String}]
+              # @!attribute [rw] retry_policy
+              #   The retry policy. The value is a hash with the following keys:
+              #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+              #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+              #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+              #       trigger a retry.
+              #   @return [::Hash]
+              # @!attribute [rw] quota_project
+              #   A separate project against which to charge quota.
+              #   @return [::String]
+              #
+              class Configuration
+                extend ::Gapic::Config
+
+                DEFAULT_ENDPOINT = "discoveryengine.googleapis.com"
+
+                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :credentials,   nil do |value|
+                  allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
+                  allowed.any? { |klass| klass === value }
+                end
+                config_attr :scope,         nil, ::String, ::Array, nil
+                config_attr :lib_name,      nil, ::String, nil
+                config_attr :lib_version,   nil, ::String, nil
+                config_attr :timeout,       nil, ::Numeric, nil
+                config_attr :metadata,      nil, ::Hash, nil
+                config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
+                config_attr :quota_project, nil, ::String, nil
+
+                # @private
+                def initialize parent_config = nil
+                  @parent_config = parent_config unless parent_config.nil?
+
+                  yield self if block_given?
+                end
+
+                ##
+                # Configurations for individual RPCs
+                # @return [Rpcs]
+                #
+                def rpcs
+                  @rpcs ||= begin
+                    parent_rpcs = nil
+                    parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
+                    Rpcs.new parent_rpcs
+                  end
+                end
+
+                ##
+                # Configuration RPC class for the CompletionService API.
+                #
+                # Includes fields providing the configuration for each RPC in this service.
+                # Each configuration object is of type `Gapic::Config::Method` and includes
+                # the following configuration fields:
+                #
+                #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
+                #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers
+                #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
+                #     include the following keys:
+                #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
+                #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
+                #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
+                #         trigger a retry.
+                #
+                class Rpcs
+                  ##
+                  # RPC-specific configuration for `complete_query`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :complete_query
+
+                  # @private
+                  def initialize parent_rpcs = nil
+                    complete_query_config = parent_rpcs.complete_query if parent_rpcs.respond_to? :complete_query
+                    @complete_query = ::Gapic::Config::Method.new complete_query_config
+
+                    yield self if block_given?
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/cloud/discoveryengine/v1/completion_service_pb"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        module CompletionService
+          module Rest
+            ##
+            # REST service stub for the CompletionService service.
+            # Service stub contains baseline method implementations
+            # including transcoding, making the REST call, and deserialing the response.
+            #
+            class ServiceStub
+              def initialize endpoint:, credentials:
+                # These require statements are intentionally placed here to initialize
+                # the REST modules only when it's required.
+                require "gapic/rest"
+
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                                                             numeric_enums: true,
+                                                             raise_faraday_errors: false
+              end
+
+              ##
+              # Baseline implementation for the complete_query REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest]
+              #   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::CompleteQueryResponse]
+              # @yieldparam operation [::Gapic::Rest::TransportOperation]
+              #
+              # @return [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
+              #   A result object deserialized from the server's reply
+              def complete_query request_pb, options = nil
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_complete_query_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::CompleteQueryResponse.decode_json response.body, ignore_unknown_fields: true
+
+                yield result, operation if block_given?
+                result
+              end
+
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the complete_query REST call
+              #
+              # @param request_pb [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_complete_query_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{data_store}:completeQuery",
+                                                          matches: [
+                                                            ["data_store", %r{^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                                                        .with_bindings(
+                                                          uri_method: :get,
+                                                          uri_template: "/v1/{data_store}:completeQuery",
+                                                          matches: [
+                                                            ["data_store", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/completion_service/credentials"
+require "google/cloud/discovery_engine/v1/completion_service/paths"
+require "google/cloud/discovery_engine/v1/completion_service/rest/client"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for Auto-Completion.
+        #
+        # To load this service and instantiate a REST client:
+        #
+        #     require "google/cloud/discovery_engine/v1/completion_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
+        #
+        module CompletionService
+          # Client for the REST transport
+          module Rest
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/discovery_engine/v1/completion_service/rest/helpers" if ::File.file? helper_path

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/common"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/discovery_engine/v1/version"
+
+require "google/cloud/discovery_engine/v1/completion_service/credentials"
+require "google/cloud/discovery_engine/v1/completion_service/paths"
+require "google/cloud/discovery_engine/v1/completion_service/client"
+require "google/cloud/discovery_engine/v1/completion_service/rest"
+
+module Google
+  module Cloud
+    module DiscoveryEngine
+      module V1
+        ##
+        # Service for Auto-Completion.
+        #
+        # @example Load this service and instantiate a gRPC client
+        #
+        #     require "google/cloud/discovery_engine/v1/completion_service"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client.new
+        #
+        # @example Load this service and instantiate a REST client
+        #
+        #     require "google/cloud/discovery_engine/v1/completion_service/rest"
+        #     client = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::Client.new
+        #
+        module CompletionService
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "completion_service", "helpers.rb"
+require "google/cloud/discovery_engine/v1/completion_service/helpers" if ::File.file? helper_path