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

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

Methods

.agents

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

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.

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.

.answer_records

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

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.

About AnswerRecords

Service for managing AnswerRecords.

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.

.configure

def self.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 a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.dialogflow)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.contexts

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

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.

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.

.conversation_datasets

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

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.

About ConversationDatasets

Conversation datasets.

Conversation datasets contain raw conversation files and their customizable 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_models

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

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.

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_profiles

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

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.

About ConversationProfiles

Service for managing ConversationProfiles.

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

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

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.

About Conversations

Service for managing Conversations.

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

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

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.

About Documents

Service for managing knowledge Documents.

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

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

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.

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.

.environments

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

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.

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.

.fulfillments

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

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.

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.

.intents

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

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.

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.

.knowledge_bases

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

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.

About KnowledgeBases

Service for managing KnowledgeBases.

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

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

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.

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.

.session_entity_types

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

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.

About SessionEntityTypes

Service for managing SessionEntityTypes.

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

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

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.

About Sessions

A service used for session interactions.

For more information, see the API interactions guide.

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

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

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.

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.

Constants

VERSION

value: "1.8.0".freeze