google-cloud-discovery_engine-v1beta 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1ee4b620a3a7533db1f510481e8b2f92a9386aca295bd24ee7349a147b1e8a4
-  data.tar.gz: 7b2404748ad8992ad0d367757e06bfa68878f32175780e4cc66a318e2840eee5
+  metadata.gz: c38099d0888d0affb8b7a6b7994f3a1f872c4dcd89f0d73b46d936ca136abcef
+  data.tar.gz: 6c89d1ee7cb59dd1cf8ff94b7929a51e90912c9fa4eb5de8e3607dd8863bd82f
 SHA512:
-  metadata.gz: 5470bd2eed6d04494d0fb6d26c12d60718a029343687e18834f68fa48efa23a37b62fdbc4a58c4d8ff669785f1f14420dec99445fa39178d48616c39e2895f49
-  data.tar.gz: 904f765667f507755a9be1b3b488e7c33ec82b988476b960aba5f7ef18248c002d737cc9e473342a7e872c80e6ca55f6fb2e11c5e2381619a3d4389e2bd58ac9
+  metadata.gz: 1f9229fb79cc50eae6767e6badcf2b7954cb6438b0ee109cb3b652d2b870aa67e9f49bfaa345267871652328dda64b8e965a772121f52cec38033e4c4879faa6
+  data.tar.gz: d742bac3155f58bb3971f01c7432f6902231b2db45d6e24a5f04aed76f6b7b06fef6aa346b7533cc31fd6533f08fd64b5cdba095ca1f6bbb8578cf16554ac336

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-v1beta/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/v1beta/completion_service/client.rb

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1beta/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::V1beta::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
 
             ##
@@ -396,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/v1beta/completion_service/rest/client.rb

@@ -19,6 +19,7 @@
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1beta/completion_service_pb"
 require "google/cloud/discovery_engine/v1beta/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::V1beta::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
 
               ##
@@ -210,6 +224,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::CompletionService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryRequest.new
+              #
+              #   # Call the complete_query method.
+              #   result = client.complete_query request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::CompleteQueryResponse.
+              #   p result
+              #
               def complete_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1beta/conversational_search_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
+
               @conversational_search_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::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 converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil)
+            # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil)
             #   Pass arguments to `converse_conversation` 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).
@@ -186,6 +201,26 @@ module Google
             #     session.
             #   @param safe_search [::Boolean]
             #     Whether to turn on safe search.
+            #   @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.
+            #   @param summary_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash]
+            #     A specification for configuring the summary returned in the response.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
@@ -849,6 +884,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 ConversationalSearchService API.
               #

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

@@ -19,6 +19,7 @@
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1beta/conversational_search_service_pb"
 require "google/cloud/discovery_engine/v1beta/conversational_search_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
+
                 @conversational_search_service_stub = ::Google::Cloud::DiscoveryEngine::V1beta::ConversationalSearchService::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 converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil)
+              # @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil)
               #   Pass arguments to `converse_conversation` 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).
@@ -177,6 +191,26 @@ module Google
               #     session.
               #   @param safe_search [::Boolean]
               #     Whether to turn on safe search.
+              #   @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.
+              #   @param summary_spec [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec::SummarySpec, ::Hash]
+              #     A specification for configuring the summary returned in the response.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -184,6 +218,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationRequest.new
+              #
+              #   # Call the converse_conversation method.
+              #   result = client.converse_conversation request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::ConverseConversationResponse.
+              #   p result
+              #
               def converse_conversation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -252,6 +302,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::CreateConversationRequest.new
+              #
+              #   # Call the create_conversation method.
+              #   result = client.create_conversation request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation.
+              #   p result
+              #
               def create_conversation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -318,6 +384,22 @@ module Google
               # @return [::Google::Protobuf::Empty]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::DeleteConversationRequest.new
+              #
+              #   # Call the delete_conversation method.
+              #   result = client.delete_conversation request
+              #
+              #   # The returned object is of type Google::Protobuf::Empty.
+              #   p result
+              #
               def delete_conversation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -393,6 +475,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::UpdateConversationRequest.new
+              #
+              #   # Call the update_conversation method.
+              #   result = client.update_conversation request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation.
+              #   p result
+              #
               def update_conversation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -456,6 +554,22 @@ module Google
               # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::GetConversationRequest.new
+              #
+              #   # Call the get_conversation method.
+              #   result = client.get_conversation request
+              #
+              #   # The returned object is of type Google::Cloud::DiscoveryEngine::V1beta::Conversation.
+              #   p result
+              #
               def get_conversation request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -543,6 +657,26 @@ module Google
               # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::DiscoveryEngine::V1beta::Conversation>]
               #
               # @raise [::Google::Cloud::Error] if the REST call 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::ConversationalSearchService::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::DiscoveryEngine::V1beta::ListConversationsRequest.new
+              #
+              #   # Call the list_conversations method.
+              #   result = client.list_conversations request
+              #
+              #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+              #   # over elements, and API calls will be issued to fetch pages as needed.
+              #   result.each do |item|
+              #     # Each element is of type ::Google::Cloud::DiscoveryEngine::V1beta::Conversation.
+              #     p item
+              #   end
+              #
               def list_conversations request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -18,6 +18,7 @@
 
 require "google/cloud/errors"
 require "google/cloud/discoveryengine/v1beta/document_service_pb"
+require "google/cloud/location"
 
 module Google
   module Cloud
@@ -151,12 +152,19 @@ module Google
                 config.endpoint = @config.endpoint
               end
 
+              @location_client = Google::Cloud::Location::Locations::Client.new do |config|
+                config.credentials = credentials
+                config.quota_project = @quota_project_id
+                config.endpoint = @config.endpoint
+              end
+
               @document_service_stub = ::Gapic::ServiceStub.new(
                 ::Google::Cloud::DiscoveryEngine::V1beta::DocumentService::Stub,
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -167,6 +175,13 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # Get the associated client for mix-in of the Locations.
+            #
+            # @return [Google::Cloud::Location::Locations::Client]
+            #
+            attr_reader :location_client
+
             # Service calls
 
             ##
@@ -1079,6 +1094,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 DocumentService API.
               #

data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb

@@ -93,7 +93,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
 
               # Used by an LRO wrapper for some methods of this service
@@ -701,6 +702,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 Operations API.
               #