module Google::Cloud::Dialogflow::CX
Constants
- VERSION
Public Class Methods
Create a new client object for Agents.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Agents::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Agents/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Agents service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Agents
Service for managing Agents.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Agents::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 157 def self.agents version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Agents).const_get(:Client).new(&block) end
Configure the google-cloud-dialogflow-cx library.
The following configuration parameters are supported:
-
`credentials` (type: `String, Hash, Google::Auth::Credentials`) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
-
`lib_name` (type: `String`) - The library name as recorded in instrumentation and logging.
-
`lib_version` (type: `String`) - The library version as recorded in instrumentation and logging.
-
`interceptors` (type: `Array<GRPC::ClientInterceptor>`) - An array of interceptors that are run before calls are executed.
-
`timeout` (type: `Numeric`) - Default timeout in seconds.
-
`metadata` (type: `Hash{Symbol=>String}`) - Additional gRPC headers to be sent with the call.
-
`retry_policy` (type: `Hash`) - 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 [::Google::Cloud::Config] The default configuration used by this library
# File lib/google/cloud/dialogflow/cx.rb, line 499 def self.configure yield ::Google::Cloud.configure.dialogflow_cx if block_given? ::Google::Cloud.configure.dialogflow_cx end
Create a new client object for EntityTypes.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/EntityTypes/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the EntityTypes service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About EntityTypes
Service for managing EntityTypes.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [EntityTypes::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 187 def self.entity_types version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:EntityTypes).const_get(:Client).new(&block) end
Create a new client object for Environments.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Environments::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Environments/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Environments service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Environments
Service for managing Environments.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Environments::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 370 def self.environments version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Environments).const_get(:Client).new(&block) end
Create a new client object for Experiments.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Experiments::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Experiments/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Experiments service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Experiments
Service for managing Experiments.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Experiments::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 400 def self.experiments version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Experiments).const_get(:Client).new(&block) end
Create a new client object for Flows.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Flows::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Flows/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Flows service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Flows
Service for managing Flows.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Flows::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 97 def self.flows version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Flows).const_get(:Client).new(&block) end
Create a new client object for Intents.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Intents::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Intents/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Intents service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Intents
Service for managing Intents.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Intents::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 217 def self.intents version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Intents).const_get(:Client).new(&block) end
Create a new client object for Pages.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Pages::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Pages/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Pages service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Pages
Service for managing Pages.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Pages::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 67 def self.pages version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Pages).const_get(:Client).new(&block) end
Create a new client object for SecuritySettingsService.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/SecuritySettingsService/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the SecuritySettingsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About SecuritySettingsService
Service for managing security settings for Dialogflow
.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [SecuritySettingsService::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 127 def self.security_settings_service version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:SecuritySettingsService).const_get(:Client).new(&block) end
Create a new client object for SessionEntityTypes.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/SessionEntityTypes/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the SessionEntityTypes service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About SessionEntityTypes
Service for managing SessionEntityTypes.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [SessionEntityTypes::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 247 def self.session_entity_types version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:SessionEntityTypes).const_get(:Client).new(&block) end
Create a new client object for Sessions.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Sessions::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Sessions/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Sessions service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Sessions
A session represents an interaction with a user. You retrieve user input and pass it to the DetectIntent method to determine user intent and respond.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Sessions::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 279 def self.sessions version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Sessions).const_get(:Client).new(&block) end
Create a new client object for TestCases.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::TestCases::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/TestCases/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the TestCases service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About TestCases
Service for managing Test Cases and Test Case Results.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [TestCases::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 340 def self.test_cases version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:TestCases).const_get(:Client).new(&block) end
Create a new client object for TransitionRouteGroups.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/TransitionRouteGroups/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the TransitionRouteGroups service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About TransitionRouteGroups
Service for managing TransitionRouteGroups.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [TransitionRouteGroups::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 309 def self.transition_route_groups version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:TransitionRouteGroups).const_get(:Client).new(&block) end
Create a new client object for Versions.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Versions::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Versions/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Versions service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Versions
Service for managing Versions.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Versions::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 460 def self.versions version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Versions).const_get(:Client).new(&block) end
Create a new client object for Webhooks.
By default, this returns an instance of [Google::Cloud::Dialogflow::CX::V3::Webhooks::Client](googleapis.dev/ruby/google-cloud-dialogflow-cx-v3/latest/Google/Cloud/Dialogflow/CX/V3/Webhooks/Client.html) for version V3 of the API. However, you can specify specify a different API version by passing it in the `version` parameter. If the Webhooks service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.
## About Webhooks
Service for managing Webhooks.
@param version [::String, ::Symbol] The API version to connect to. Optional.
Defaults to `:v3`.
@return [Webhooks::Client] A client object for the specified version.
# File lib/google/cloud/dialogflow/cx.rb, line 430 def self.webhooks version: :v3, &block require "google/cloud/dialogflow/cx/#{version.to_s.downcase}" package_name = Google::Cloud::Dialogflow::CX .constants .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") } .first package_module = Google::Cloud::Dialogflow::CX.const_get package_name package_module.const_get(:Webhooks).const_get(:Client).new(&block) end