google-cloud-discovery_engine-v1 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30d78914603c2b13354d1f88c053a95031ee1317c7ce2165b59ced9e9d34716a
-  data.tar.gz: e98e62f6453196d46c513ef889a2db72432f2c02b9ec6792de79c52360d4ed42
+  metadata.gz: 612779fb26fbf2d52a5d3c825d5e664bc23206248dc5a171b723e7d5f5e1a852
+  data.tar.gz: ee192e70a8de293037cb9b2d8d97788c7501f7537e647bb20d330a304835ebf7
 SHA512:
-  metadata.gz: 6985decb9c114639f247d59b47960ae5c0f0064792a7a0f453449a27270dfd853a220cc899aed18dc6cb7795e9c5ced9c7b2da33b930f32e2dc3ee346e79efc9
-  data.tar.gz: 2e73dabcad603716dbf67e98e68eb1f0726ab3eee2addeb96a7fa737a20f5b6e369c60a3a3a34f7f8805a039e49ed23880e4abbae024e607429bdfd2fcc99e8d
+  metadata.gz: a5642a09d8b0e95211e5feeae43578c80fec411a6d08334852c199c4eb3de7eba954a4b4a5fb5c24e680923313f619e6c3e15df350c0bd90593c07225f08a6fa
+  data.tar.gz: ffb576b76c3bf6ddb71389b7e36add869500050a4bf7d42a146b5a99d401f12fdce475e872ec4b84ee46965970c00f58a963903d03e543600e33baced6315caf

data/README.md

@@ -40,7 +40,7 @@ response = client.complete_query request
 View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-discovery_engine-v1/latest)
 for class and method documentation.
 
-See also the [Product Documentation](https://cloud.google.com/discovery-engine/media/docs)
+See also the [Product Documentation](https://cloud.google.com/generative-ai-app-builder/docs)
 for general usage information.
 
 ## Enabling Logging

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1/completion_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -138,15 +139,29 @@ module Google
               @quota_project_id = @config.quota_project
               @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @completion_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Stub,
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -162,7 +177,7 @@ module Google
             #   @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)
+            # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil, include_tail_suggestions: 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).
@@ -184,13 +199,14 @@ module Google
             #     API calls. Do not use it when there is no traffic for Search API.
             #     * `user-event` - Using suggestions generated from user-imported search
             #     events.
+            #     * `document-completable` - Using suggestions taken directly from
+            #     user-imported document fields marked as completable.
             #
             #     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.
+            #     [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
@@ -206,6 +222,11 @@ module Google
             #
             #     The field must be a UTF-8 encoded string with a length limit of 128
             #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            #   @param include_tail_suggestions [::Boolean]
+            #     Indicates if tail suggestions should be returned if there are no
+            #     suggestions that match the full query. Even if set to true, if there are
+            #     suggestions that match the full query, those are returned and no
+            #     tail suggestions are returned.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
@@ -390,6 +411,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the CompletionService API.
               #

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

@@ -19,6 +19,7 @@
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1/completion_service_pb"
 require "google/cloud/discovery_engine/v1/completion_service/rest/service_stub"
+require "google/cloud/location/rest"
 
 module Google
   module Cloud
@@ -135,9 +136,22 @@ module Google
                 @quota_project_id = @config.quota_project
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
+                @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
+                  config.credentials = credentials
+                  config.quota_project = @quota_project_id
+                  config.endpoint = @config.endpoint
+                end
+
                 @completion_service_stub = ::Google::Cloud::DiscoveryEngine::V1::CompletionService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
               end
 
+              ##
+              # Get the associated client for mix-in of the Locations.
+              #
+              # @return [Google::Cloud::Location::Locations::Rest::Client]
+              #
+              attr_reader :location_client
+
               # Service calls
 
               ##
@@ -153,7 +167,7 @@ module Google
               #   @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)
+              # @overload complete_query(data_store: nil, query: nil, query_model: nil, user_pseudo_id: nil, include_tail_suggestions: 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).
@@ -175,13 +189,14 @@ module Google
               #     API calls. Do not use it when there is no traffic for Search API.
               #     * `user-event` - Using suggestions generated from user-imported search
               #     events.
+              #     * `document-completable` - Using suggestions taken directly from
+              #     user-imported document fields marked as completable.
               #
               #     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.
+              #     [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
@@ -197,6 +212,11 @@ module Google
               #
               #     The field must be a UTF-8 encoded string with a length limit of 128
               #     characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              #   @param include_tail_suggestions [::Boolean]
+              #     Indicates if tail suggestions should be returned if there are no
+              #     suggestions that match the full query. Even if set to true, if there are
+              #     suggestions that match the full query, those are returned and no
+              #     tail suggestions are returned.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -204,6 +224,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse]
               #
               # @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::CompletionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1::CompleteQueryRequest.new
+              #
+              #   # Call the complete_query method.
+              #   result = client.complete_query request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1::CompleteQueryResponse.
+              #   p result
+              #
               def complete_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?