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

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

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Agents service. You can determine whether the method will succeed by calling CX.agents_available?.

About Agents

Service for managing Agents.

Determines whether the Agents service is supported by the current client. If true, you can retrieve a client object by calling CX.agents. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Agents service, or if the versioned client gem needs an update to support the Agents service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Changelogs service. You can determine whether the method will succeed by calling CX.changelogs_available?.

About Changelogs

Service for managing Changelogs.

Determines whether the Changelogs service is supported by the current client. If true, you can retrieve a client object by calling CX.changelogs. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Changelogs service, or if the versioned client gem needs an update to support the Changelogs service.

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.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Deployments service. You can determine whether the method will succeed by calling CX.deployments_available?.

About Deployments

Service for managing Deployments.

Determines whether the Deployments service is supported by the current client. If true, you can retrieve a client object by calling CX.deployments. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Deployments service, or if the versioned client gem needs an update to support the Deployments service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EntityTypes service. You can determine whether the method will succeed by calling CX.entity_types_available?.

About EntityTypes

Service for managing EntityTypes.

Determines whether the EntityTypes service is supported by the current client. If true, you can retrieve a client object by calling CX.entity_types. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EntityTypes service, or if the versioned client gem needs an update to support the EntityTypes service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Environments service. You can determine whether the method will succeed by calling CX.environments_available?.

About Environments

Service for managing Environments.

Determines whether the Environments service is supported by the current client. If true, you can retrieve a client object by calling CX.environments. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Environments service, or if the versioned client gem needs an update to support the Environments service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Experiments service. You can determine whether the method will succeed by calling CX.experiments_available?.

About Experiments

Service for managing Experiments.

Determines whether the Experiments service is supported by the current client. If true, you can retrieve a client object by calling CX.experiments. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Experiments service, or if the versioned client gem needs an update to support the Experiments service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Flows service. You can determine whether the method will succeed by calling CX.flows_available?.

About Flows

Service for managing Flows.

Determines whether the Flows service is supported by the current client. If true, you can retrieve a client object by calling CX.flows. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Flows service, or if the versioned client gem needs an update to support the Flows service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Generators service. You can determine whether the method will succeed by calling CX.generators_available?.

About Generators

Service for managing Generators

Determines whether the Generators service is supported by the current client. If true, you can retrieve a client object by calling CX.generators. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Generators service, or if the versioned client gem needs an update to support the Generators service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Intents service. You can determine whether the method will succeed by calling CX.intents_available?.

About Intents

Service for managing Intents.

Determines whether the Intents service is supported by the current client. If true, you can retrieve a client object by calling CX.intents. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Intents service, or if the versioned client gem needs an update to support the Intents service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Pages service. You can determine whether the method will succeed by calling CX.pages_available?.

About Pages

Service for managing Pages.

Determines whether the Pages service is supported by the current client. If true, you can retrieve a client object by calling CX.pages. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Pages service, or if the versioned client gem needs an update to support the Pages service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SecuritySettingsService service. You can determine whether the method will succeed by calling CX.security_settings_service_available?.

About SecuritySettingsService

Service for managing security settings for Dialogflow.

Determines whether the SecuritySettingsService service is supported by the current client. If true, you can retrieve a client object by calling CX.security_settings_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SecuritySettingsService service, or if the versioned client gem needs an update to support the SecuritySettingsService service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SessionEntityTypes service. You can determine whether the method will succeed by calling CX.session_entity_types_available?.

About SessionEntityTypes

Service for managing SessionEntityTypes.

Determines whether the SessionEntityTypes service is supported by the current client. If true, you can retrieve a client object by calling CX.session_entity_types. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SessionEntityTypes service, or if the versioned client gem needs an update to support the SessionEntityTypes service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Sessions service. You can determine whether the method will succeed by calling CX.sessions_available?.

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.

Determines whether the Sessions service is supported by the current client. If true, you can retrieve a client object by calling CX.sessions. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Sessions service, or if the versioned client gem needs an update to support the Sessions service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TestCases service. You can determine whether the method will succeed by calling CX.test_cases_available?.

About TestCases

Service for managing Test Cases and Test Case Results.

Determines whether the TestCases service is supported by the current client. If true, you can retrieve a client object by calling CX.test_cases. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TestCases service, or if the versioned client gem needs an update to support the TestCases service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TransitionRouteGroups service. You can determine whether the method will succeed by calling CX.transition_route_groups_available?.

About TransitionRouteGroups

Service for managing TransitionRouteGroups.

Determines whether the TransitionRouteGroups service is supported by the current client. If true, you can retrieve a client object by calling CX.transition_route_groups. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TransitionRouteGroups service, or if the versioned client gem needs an update to support the TransitionRouteGroups service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Versions service. You can determine whether the method will succeed by calling CX.versions_available?.

About Versions

Service for managing Versions.

Determines whether the Versions service is supported by the current client. If true, you can retrieve a client object by calling CX.versions. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Versions service, or if the versioned client gem needs an update to support the Versions service.

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.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Webhooks service. You can determine whether the method will succeed by calling CX.webhooks_available?.

About Webhooks

Service for managing Webhooks.

Determines whether the Webhooks service is supported by the current client. If true, you can retrieve a client object by calling CX.webhooks. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Webhooks service, or if the versioned client gem needs an update to support the Webhooks service.

value: "1.3.0"