Dialogflow CX API - Module Google::Cloud::Dialogflow::CX (v1.1.0)

Reference documentation and code samples for the Dialogflow CX API module Google::Cloud::Dialogflow::CX.

Methods

.agents

def self.agents(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Agents.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Agents::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Agents

Service for managing Agents.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.changelogs

def self.changelogs(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Changelogs.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Changelogs::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Changelogs service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Changelogs

Service for managing Changelogs.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.configure

def self.configure() -> ::Google::Cloud::Config

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 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.
Yields
  • (::Google::Cloud.configure.dialogflow_cx)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.deployments

def self.deployments(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Deployments.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Deployments::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Deployments service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Deployments

Service for managing Deployments.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.entity_types

def self.entity_types(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for EntityTypes.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::EntityTypes::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About EntityTypes

Service for managing EntityTypes.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.environments

def self.environments(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Environments.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Environments::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Environments

Service for managing Environments.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.experiments

def self.experiments(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Experiments.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Experiments::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Experiments

Service for managing Experiments.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.flows

def self.flows(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Flows.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Flows::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Flows

Service for managing Flows.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.generators

def self.generators(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Generators.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Generators::Client for a gRPC client for version V3 of the API. However, you can specify a different API version by passing it in the version parameter. If the Generators service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Generators

Service for managing Generators

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.intents

def self.intents(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Intents.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Intents::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Intents

Service for managing Intents.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.pages

def self.pages(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Pages.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Pages::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Pages

Service for managing Pages.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.security_settings_service

def self.security_settings_service(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for SecuritySettingsService.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::SecuritySettingsService::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About SecuritySettingsService

Service for managing security settings for Dialogflow.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.session_entity_types

def self.session_entity_types(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for SessionEntityTypes.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::SessionEntityTypes::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About SessionEntityTypes

Service for managing SessionEntityTypes.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.sessions

def self.sessions(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Sessions.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Sessions::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

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.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.test_cases

def self.test_cases(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TestCases.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::TestCases::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About TestCases

Service for managing Test Cases and Test Case Results.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.transition_route_groups

def self.transition_route_groups(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for TransitionRouteGroups.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::TransitionRouteGroups::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About TransitionRouteGroups

Service for managing TransitionRouteGroups.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.versions

def self.versions(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Versions.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Versions::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Versions

Service for managing Versions.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.webhooks

def self.webhooks(version: :v3, transport: :grpc, &block) -> ::Object

Create a new client object for Webhooks.

By default, this returns an instance of Google::Cloud::Dialogflow::CX::V3::Webhooks::Client for a gRPC client for version V3 of the API. However, you can 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. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

About Webhooks

Service for managing Webhooks.

Parameters
  • version (::String, ::Symbol) (defaults to: :v3) — The API version to connect to. Optional. Defaults to :v3.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

Constants

VERSION

value: "1.1.0"