Class: Google::Cloud::Dialogflow::V2::ConversationProfiles::Client
- Inherits:
-
Object
- Object
- Google::Cloud::Dialogflow::V2::ConversationProfiles::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb
Overview
Client for the ConversationProfiles service.
Service for managing ConversationProfiles.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#location_client ⇒ Google::Cloud::Location::Locations::Client
readonly
Get the associated client for mix-in of the Locations.
-
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client class.
Instance Method Summary collapse
-
#clear_suggestion_feature_config(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Clears a suggestion feature from a conversation profile for the given participant role.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client instance.
-
#create_conversation_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Creates a conversation profile in the specified project.
-
#delete_conversation_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes the specified conversation profile.
-
#get_conversation_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Retrieves the specified conversation profile.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new ConversationProfiles client object.
-
#list_conversation_profiles(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>
Returns the list of all conversation profiles in the specified project.
-
#logger ⇒ Logger
The logger used for request/response debug logging.
-
#set_suggestion_feature_config(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Adds or updates a suggestion feature in a conversation profile.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_conversation_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Updates the specified conversation profile.
Methods included from Paths
#agent_path, #conversation_model_path, #conversation_profile_path, #cx_security_settings_path, #document_path, #generator_path, #knowledge_base_path, #location_path, #phrase_set_path, #project_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new ConversationProfiles client object.
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 131 def initialize # These require statements are intentionally placed here to initialize # the gRPC module only when it's required. # See https://github.com/googleapis/toolkit/issues/446 require "gapic/grpc" require "google/cloud/dialogflow/v2/conversation_profile_services_pb" # 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.nil? || (@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 @operations_client = Operations.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @config.endpoint config.universe_domain = @config.universe_domain end @conversation_profiles_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool, logger: @config.logger ) @conversation_profiles_stub.stub_logger&.info do |entry| entry.set_system_name entry.set_service entry. = "Created client for #{entry.service}" entry.set_credentials_fields credentials entry.set "customEndpoint", @config.endpoint if @config.endpoint entry.set "defaultTimeout", @config.timeout if @config.timeout entry.set "quotaProject", @quota_project_id if @quota_project_id end @location_client = Google::Cloud::Location::Locations::Client.new do |config| config.credentials = credentials config.quota_project = @quota_project_id config.endpoint = @conversation_profiles_stub.endpoint config.universe_domain = @conversation_profiles_stub.universe_domain config.logger = @conversation_profiles_stub.logger if config.respond_to? :logger= end end |
Instance Attribute Details
#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)
Get the associated client for mix-in of the Locations.
209 210 211 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 209 def location_client @location_client end |
#operations_client ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfiles::Operations (readonly)
Get the associated client for long-running operations.
202 203 204 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 202 def operations_client @operations_client end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles Client class.
See Configuration for a description of the configuration fields.
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 64 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Dialogflow", "V2"] 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 = 60.0 default_config.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14] } default_config end yield @configure if block_given? @configure end |
Instance Method Details
#clear_suggestion_feature_config(request, options = nil) ⇒ ::Gapic::Operation #clear_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_type: nil) ⇒ ::Gapic::Operation
Clears a suggestion feature from a conversation profile for the given participant role.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: ClearSuggestionFeatureConfigOperationMetadataresponse
: ConversationProfile
868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 868 def clear_suggestion_feature_config request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ClearSuggestionFeatureConfigRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.clear_suggestion_feature_config..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile header_params["conversation_profile"] = request.conversation_profile end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.clear_suggestion_feature_config.timeout, metadata: , retry_policy: @config.rpcs.clear_suggestion_feature_config.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :clear_suggestion_feature_config, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? throw :response, response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#configure {|config| ... } ⇒ Client::Configuration
Configure the ConversationProfiles 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 configure.
See Configuration for a description of the configuration fields.
101 102 103 104 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 101 def configure yield @config if block_given? @config end |
#create_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #create_conversation_profile(parent: nil, conversation_profile: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Creates a conversation profile in the specified project.
ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 460 def create_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::CreateConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_conversation_profile..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.create_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.create_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :create_conversation_profile, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_conversation_profile(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_conversation_profile(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes the specified conversation profile.
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 641 def delete_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::DeleteConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_conversation_profile..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.delete_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :delete_conversation_profile, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #get_conversation_profile(name: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Retrieves the specified conversation profile.
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 365 def get_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::GetConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_conversation_profile..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.name header_params["name"] = request.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.get_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :get_conversation_profile, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#list_conversation_profiles(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile> #list_conversation_profiles(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::V2::ConversationProfile>
Returns the list of all conversation profiles in the specified project.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 276 def list_conversation_profiles request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::ListConversationProfilesRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_conversation_profiles..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.parent header_params["parent"] = request.parent end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.list_conversation_profiles.timeout, metadata: , retry_policy: @config.rpcs.list_conversation_profiles.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :list_conversation_profiles, request, options: do |response, operation| response = ::Gapic::PagedEnumerable.new @conversation_profiles_stub, :list_conversation_profiles, request, response, operation, yield response, operation if block_given? throw :response, response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#logger ⇒ Logger
The logger used for request/response debug logging.
216 217 218 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 216 def logger @conversation_profiles_stub.logger end |
#set_suggestion_feature_config(request, options = nil) ⇒ ::Gapic::Operation #set_suggestion_feature_config(conversation_profile: nil, participant_role: nil, suggestion_feature_config: nil) ⇒ ::Gapic::Operation
Adds or updates a suggestion feature in a conversation profile. If the conversation profile contains the type of suggestion feature for the participant role, it will update it. Otherwise it will insert the suggestion feature.
This method is a long-running
operation.
The returned Operation
type has the following method-specific fields:
metadata
: SetSuggestionFeatureConfigOperationMetadataresponse
: ConversationProfile
If a long running operation to add or update suggestion feature config for the same conversation profile, participant role and suggestion feature type exists, please cancel the existing long running operation before sending such request, otherwise the request will be rejected.
757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 757 def set_suggestion_feature_config request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::SetSuggestionFeatureConfigRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.set_suggestion_feature_config..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile header_params["conversation_profile"] = request.conversation_profile end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.set_suggestion_feature_config.timeout, metadata: , retry_policy: @config.rpcs.set_suggestion_feature_config.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :set_suggestion_feature_config, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? throw :response, response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
111 112 113 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 111 def universe_domain @conversation_profiles_stub.universe_domain end |
#update_conversation_profile(request, options = nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile #update_conversation_profile(conversation_profile: nil, update_mask: nil) ⇒ ::Google::Cloud::Dialogflow::V2::ConversationProfile
Updates the specified conversation profile.
ConversationProfile.create_time and ConversationProfile.update_time aren't populated in the response. You can retrieve them via GetConversationProfile API.
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 |
# File 'lib/google/cloud/dialogflow/v2/conversation_profiles/client.rb', line 554 def update_conversation_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::V2::UpdateConversationProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_conversation_profile..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = {} if request.conversation_profile&.name header_params["conversation_profile.name"] = request.conversation_profile.name end request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_conversation_profile.timeout, metadata: , retry_policy: @config.rpcs.update_conversation_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @conversation_profiles_stub.call_rpc :update_conversation_profile, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |