Dialogflow API - Module Google::Cloud::Dialogflow (v1.10.0)

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

Create a new client object for Agents.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Agents::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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 AnswerRecords.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::AnswerRecords::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the AnswerRecords 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 AnswerRecords service. You can determine whether the method will succeed by calling Dialogflow.answer_records_available?.

About AnswerRecords

Service for managing AnswerRecords.

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

Configure the google-cloud-dialogflow 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 Contexts.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Contexts::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Contexts 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 Contexts service. You can determine whether the method will succeed by calling Dialogflow.contexts_available?.

About Contexts

Service for managing Contexts.

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

Create a new client object for ConversationDatasets.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::ConversationDatasets::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ConversationDatasets 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 ConversationDatasets service. You can determine whether the method will succeed by calling Dialogflow.conversation_datasets_available?.

About ConversationDatasets

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable metadata that can be used for model training.

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

Create a new client object for ConversationModels.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::ConversationModels::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ConversationModels 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 ConversationModels service. You can determine whether the method will succeed by calling Dialogflow.conversation_models_available?.

About ConversationModels

Manages a collection of models for human agent assistant.

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

Create a new client object for ConversationProfiles.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::ConversationProfiles::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the ConversationProfiles 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 ConversationProfiles service. You can determine whether the method will succeed by calling Dialogflow.conversation_profiles_available?.

About ConversationProfiles

Service for managing ConversationProfiles.

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

Create a new client object for Conversations.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Conversations::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Conversations 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 Conversations service. You can determine whether the method will succeed by calling Dialogflow.conversations_available?.

About Conversations

Service for managing Conversations.

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

Create a new client object for Documents.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Documents::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Documents 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 Documents service. You can determine whether the method will succeed by calling Dialogflow.documents_available?.

About Documents

Service for managing knowledge Documents.

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

Create a new client object for EncryptionSpecService.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::EncryptionSpecService::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the EncryptionSpecService 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 EncryptionSpecService service. You can determine whether the method will succeed by calling Dialogflow.encryption_spec_service_available?.

About EncryptionSpecService

Manages encryption spec settings for Dialogflow and Agent Assist.

Determines whether the EncryptionSpecService service is supported by the current client. If true, you can retrieve a client object by calling Dialogflow.encryption_spec_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 EncryptionSpecService service, or if the versioned client gem needs an update to support the EncryptionSpecService service.

Create a new client object for EntityTypes.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::EntityTypes::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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::V2::Environments::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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 Fulfillments.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Fulfillments::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Fulfillments 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 Fulfillments service. You can determine whether the method will succeed by calling Dialogflow.fulfillments_available?.

About Fulfillments

Service for managing Fulfillments.

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

Create a new client object for Generators.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Generators::Client for a gRPC client for version V2 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 Dialogflow.generators_available?.

About Generators

Generator Service for LLM powered Agent Assist. This service manages the configurations of user owned Generators, such as description, context and instruction, input/output format, etc. The generator resources will be used inside a conversation and will be triggered by TriggerEvent to query LLM for answers.

Determines whether the Generators service is supported by the current client. If true, you can retrieve a client object by calling Dialogflow.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::V2::Intents::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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 KnowledgeBases.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::KnowledgeBases::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the KnowledgeBases 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 KnowledgeBases service. You can determine whether the method will succeed by calling Dialogflow.knowledge_bases_available?.

About KnowledgeBases

Service for managing KnowledgeBases.

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

Create a new client object for Participants.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Participants::Client for a gRPC client for version V2 of the API. However, you can specify a different API version by passing it in the version parameter. If the Participants 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 Participants service. You can determine whether the method will succeed by calling Dialogflow.participants_available?.

About Participants

Service for managing Participants.

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

Create a new client object for SessionEntityTypes.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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::V2::Sessions::Client for a gRPC client for version V2 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 Dialogflow.sessions_available?.

About Sessions

A service used for session interactions.

For more information, see the API interactions guide.

Determines whether the Sessions service is supported by the current client. If true, you can retrieve a client object by calling Dialogflow.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 Versions.

By default, this returns an instance of Google::Cloud::Dialogflow::V2::Versions::Client for a gRPC client for version V2 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 Dialogflow.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 Dialogflow.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.

value: "1.10.0".freeze