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

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

Methods

.agents

defself.agents(version::v2,transport::grpc,&block)->::Object

Create a new client object for Agents.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Agents::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Agents service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Agents

Service for managing Agents.

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

.agents_available?

defself.agents_available?(version::v2,transport::grpc)->boolean

Determines whether the Agents service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.agents.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.answer_records

defself.answer_records(version::v2,transport::grpc,&block)->::Object

Create a new client object for AnswerRecords.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::AnswerRecords::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the AnswerRecords service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the AnswerRecords service.You can determine whether the method will succeed by callingDialogflow.answer_records_available?.

About AnswerRecords

Service for managingAnswerRecords.

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

.answer_records_available?

defself.answer_records_available?(version::v2,transport::grpc)->boolean

Determines whether the AnswerRecords service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.answer_records.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.configure

defself.configure()->::Google::Cloud::Config

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

.contexts

defself.contexts(version::v2,transport::grpc,&block)->::Object

Create a new client object for Contexts.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Contexts::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Contexts service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Contexts service.You can determine whether the method will succeed by callingDialogflow.contexts_available?.

About Contexts

Service for managing Contexts.

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

.contexts_available?

defself.contexts_available?(version::v2,transport::grpc)->boolean

Determines whether the Contexts service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.contexts.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.conversation_datasets

defself.conversation_datasets(version::v2,transport::grpc,&block)->::Object

Create a new client object for ConversationDatasets.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::ConversationDatasets::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the ConversationDatasets service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the ConversationDatasets service.You can determine whether the method will succeed by callingDialogflow.conversation_datasets_available?.

About ConversationDatasets

Conversation datasets.

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

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

.conversation_datasets_available?

defself.conversation_datasets_available?(version::v2,transport::grpc)->boolean

Determines whether the ConversationDatasets service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.conversation_datasets.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.conversation_models

defself.conversation_models(version::v2,transport::grpc,&block)->::Object

Create a new client object for ConversationModels.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::ConversationModels::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the ConversationModels service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the ConversationModels service.You can determine whether the method will succeed by callingDialogflow.conversation_models_available?.

About ConversationModels

Manages a collection of models for human agent assistant.

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

.conversation_models_available?

defself.conversation_models_available?(version::v2,transport::grpc)->boolean

Determines whether the ConversationModels service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.conversation_models.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.conversation_profiles

defself.conversation_profiles(version::v2,transport::grpc,&block)->::Object

Create a new client object for ConversationProfiles.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::ConversationProfiles::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the ConversationProfiles service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the ConversationProfiles service.You can determine whether the method will succeed by callingDialogflow.conversation_profiles_available?.

About ConversationProfiles

Service for managingConversationProfiles.

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

.conversation_profiles_available?

defself.conversation_profiles_available?(version::v2,transport::grpc)->boolean

Determines whether the ConversationProfiles service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.conversation_profiles.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.conversations

defself.conversations(version::v2,transport::grpc,&block)->::Object

Create a new client object for Conversations.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Conversations::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Conversations service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Conversations service.You can determine whether the method will succeed by callingDialogflow.conversations_available?.

About Conversations

Service for managingConversations.

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

.conversations_available?

defself.conversations_available?(version::v2,transport::grpc)->boolean

Determines whether the Conversations service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.conversations.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.documents

defself.documents(version::v2,transport::grpc,&block)->::Object

Create a new client object for Documents.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Documents::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Documents service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Documents service.You can determine whether the method will succeed by callingDialogflow.documents_available?.

About Documents

Service for managing knowledgeDocuments.

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

.documents_available?

defself.documents_available?(version::v2,transport::grpc)->boolean

Determines whether the Documents service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.documents.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.encryption_spec_service

defself.encryption_spec_service(version::v2,transport::grpc,&block)->::Object

Create a new client object for EncryptionSpecService.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::EncryptionSpecService::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the EncryptionSpecService service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the EncryptionSpecService service.You can determine whether the method will succeed by callingDialogflow.encryption_spec_service_available?.

About EncryptionSpecService

Manages encryption spec settings for Dialogflow and Agent Assist.

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

.encryption_spec_service_available?

defself.encryption_spec_service_available?(version::v2,transport::grpc)->boolean

Determines whether the EncryptionSpecService service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.encryption_spec_service.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.entity_types

defself.entity_types(version::v2,transport::grpc,&block)->::Object

Create a new client object for EntityTypes.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::EntityTypes::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the EntityTypes service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About EntityTypes

Service for managing EntityTypes.

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

.entity_types_available?

defself.entity_types_available?(version::v2,transport::grpc)->boolean

Determines whether the EntityTypes service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.entity_types.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.environments

defself.environments(version::v2,transport::grpc,&block)->::Object

Create a new client object for Environments.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Environments::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Environments service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Environments

Service for managing Environments.

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

.environments_available?

defself.environments_available?(version::v2,transport::grpc)->boolean

Determines whether the Environments service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.environments.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.fulfillments

defself.fulfillments(version::v2,transport::grpc,&block)->::Object

Create a new client object for Fulfillments.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Fulfillments::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Fulfillments service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Fulfillments service.You can determine whether the method will succeed by callingDialogflow.fulfillments_available?.

About Fulfillments

Service for managing Fulfillments.

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

.fulfillments_available?

defself.fulfillments_available?(version::v2,transport::grpc)->boolean

Determines whether the Fulfillments service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.fulfillments.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.generator_evaluations

defself.generator_evaluations(version::v2,transport::grpc,&block)->::Object

Create a new client object for GeneratorEvaluations.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::GeneratorEvaluations::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the GeneratorEvaluations service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the GeneratorEvaluations service.You can determine whether the method will succeed by callingDialogflow.generator_evaluations_available?.

About GeneratorEvaluations

Service for managing generator evaluations.

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

.generator_evaluations_available?

defself.generator_evaluations_available?(version::v2,transport::grpc)->boolean

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

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.generators

defself.generators(version::v2,transport::grpc,&block)->::Object

Create a new client object for Generators.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Generators::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Generators service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Generators

Generator Service for LLM powered Agent Assist. This service manages theconfigurations of user owned Generators, such as description, context andinstruction, input/output format, etc. The generator resources will be usedinside a conversation and will be triggered by TriggerEvent to query LLM foranswers.

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

.generators_available?

defself.generators_available?(version::v2,transport::grpc)->boolean

Determines whether the Generators service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.generators.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.intents

defself.intents(version::v2,transport::grpc,&block)->::Object

Create a new client object for Intents.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Intents::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Intents service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Intents

Service for managing Intents.

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

.intents_available?

defself.intents_available?(version::v2,transport::grpc)->boolean

Determines whether the Intents service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.intents.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.knowledge_bases

defself.knowledge_bases(version::v2,transport::grpc,&block)->::Object

Create a new client object for KnowledgeBases.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::KnowledgeBases::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the KnowledgeBases service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the KnowledgeBases service.You can determine whether the method will succeed by callingDialogflow.knowledge_bases_available?.

About KnowledgeBases

Service for managingKnowledgeBases.

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

.knowledge_bases_available?

defself.knowledge_bases_available?(version::v2,transport::grpc)->boolean

Determines whether the KnowledgeBases service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.knowledge_bases.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.participants

defself.participants(version::v2,transport::grpc,&block)->::Object

Create a new client object for Participants.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Participants::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Participants service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Participants service.You can determine whether the method will succeed by callingDialogflow.participants_available?.

About Participants

Service for managing Participants.

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

.participants_available?

defself.participants_available?(version::v2,transport::grpc)->boolean

Determines whether the Participants service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.participants.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.session_entity_types

defself.session_entity_types(version::v2,transport::grpc,&block)->::Object

Create a new client object for SessionEntityTypes.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::SessionEntityTypes::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the SessionEntityTypes service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About SessionEntityTypes

Service for managingSessionEntityTypes.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • 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_available?

defself.session_entity_types_available?(version::v2,transport::grpc)->boolean

Determines whether the SessionEntityTypes service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.session_entity_types.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.sessions

defself.sessions(version::v2,transport::grpc,&block)->::Object

Create a new client object for Sessions.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Sessions::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Sessions service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Sessions

A service used for session interactions.

For more information, see theAPI interactionsguide.

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

.sessions_available?

defself.sessions_available?(version::v2,transport::grpc)->boolean

Determines whether the Sessions service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.sessions.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.sip_trunks

defself.sip_trunks(version::v2,transport::grpc,&block)->::Object

Create a new client object for SipTrunks.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::SipTrunks::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the SipTrunks service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the SipTrunks service.You can determine whether the method will succeed by callingDialogflow.sip_trunks_available?.

About SipTrunks

Service for managing SipTrunks.

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

.sip_trunks_available?

defself.sip_trunks_available?(version::v2,transport::grpc)->boolean

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

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.tools

defself.tools(version::v2,transport::grpc,&block)->::Object

Create a new client object for Tools.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Tools::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Tools service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

Raises an exception if the currently installed versioned client gem for thegiven API version does not support the given transport of the Tools service.You can determine whether the method will succeed by callingDialogflow.tools_available?.

About Tools

Tool Service for LLM powered Agent Assist. Tools can be used to interact withremote APIs (e.g. fetching orders) to retrieve additional information asinput to LLM.

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

.tools_available?

defself.tools_available?(version::v2,transport::grpc)->boolean

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

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

.versions

defself.versions(version::v2,transport::grpc,&block)->::Object

Create a new client object for Versions.

By default, this returns an instance ofGoogle::Cloud::Dialogflow::V2::Versions::Clientfor a gRPC client for version V2 of the API.However, you can specify a different API version by passing it in theversion parameter. If the Versions service issupported by that API version, and the corresponding gem is available, theappropriate versioned client will be returned.You can also specify a different transport by passing:rest or:grpc inthetransport parameter.

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

About Versions

Service for managing Versions.

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

.versions_available?

defself.versions_available?(version::v2,transport::grpc)->boolean

Determines whether the Versions service is supported by the current client.If true, you can retrieve a client object by callingDialogflow.versions.If false, that method will raise an exception. This could happen if the givenAPI 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.

Parameters
  • version (::String, ::Symbol)(defaults to: :v2) — The API version to connect to. Optional.Defaults to:v2.
  • transport (:grpc, :rest)(defaults to: :grpc) — The transport to use. Defaults to:grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value:"1.12.0".freeze

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-16 UTC.