module Google::Cloud::Dialogflow

Constants

VERSION

Public Class Methods

agents(version: :v2, &block) click to toggle source

Create a new client object for Agents.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Agents::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Agents/Client.html) for version V2 of the API. However, you can specify 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.

## About Agents

Service for managing Agents.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Agents::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 66
def self.agents version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Agents).const_get(:Client).new(&block)
end
answer_records(version: :v2, &block) click to toggle source

Create a new client object for AnswerRecords.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::AnswerRecords::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/AnswerRecords/Client.html) for version V2 of the API. However, you can specify 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.

## About AnswerRecords

Service for managing AnswerRecords.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [AnswerRecords::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 279
def self.answer_records version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:AnswerRecords).const_get(:Client).new(&block)
end
configure() { |configure.dialogflow| ... } click to toggle source

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 gRPC 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.

@return [::Google::Cloud::Config] The default configuration used by this library

# File lib/google/cloud/dialogflow.rb, line 528
def self.configure
  yield ::Google::Cloud.configure.dialogflow if block_given?

  ::Google::Cloud.configure.dialogflow
end
contexts(version: :v2, &block) click to toggle source

Create a new client object for Contexts.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Contexts::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Contexts/Client.html) for version V2 of the API. However, you can specify 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.

## About Contexts

Service for managing Contexts.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Contexts::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 96
def self.contexts version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Contexts).const_get(:Client).new(&block)
end
conversation_profiles(version: :v2, &block) click to toggle source

Create a new client object for ConversationProfiles.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::ConversationProfiles::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/ConversationProfiles/Client.html) for version V2 of the API. However, you can specify 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.

## About ConversationProfiles

Service for managing ConversationProfiles.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [ConversationProfiles::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 339
def self.conversation_profiles version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:ConversationProfiles).const_get(:Client).new(&block)
end
conversations(version: :v2, &block) click to toggle source

Create a new client object for Conversations.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Conversations::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Conversations/Client.html) for version V2 of the API. However, you can specify 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.

## About Conversations

Service for managing Conversations.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Conversations::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 309
def self.conversations version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Conversations).const_get(:Client).new(&block)
end
documents(version: :v2, &block) click to toggle source

Create a new client object for Documents.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Documents::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Documents/Client.html) for version V2 of the API. However, you can specify 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.

## About Documents

Service for managing knowledge Documents.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Documents::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 369
def self.documents version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Documents).const_get(:Client).new(&block)
end
entity_types(version: :v2, &block) click to toggle source

Create a new client object for EntityTypes.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::EntityTypes::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/EntityTypes/Client.html) for version V2 of the API. However, you can specify 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.

## About EntityTypes

Service for managing EntityTypes.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [EntityTypes::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 156
def self.entity_types version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:EntityTypes).const_get(:Client).new(&block)
end
environments(version: :v2, &block) click to toggle source

Create a new client object for Environments.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Environments::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Environments/Client.html) for version V2 of the API. However, you can specify 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.

## About Environments

Service for managing Environments.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Environments::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 429
def self.environments version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Environments).const_get(:Client).new(&block)
end
fulfillments(version: :v2, &block) click to toggle source

Create a new client object for Fulfillments.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Fulfillments::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Fulfillments/Client.html) for version V2 of the API. However, you can specify 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.

## About Fulfillments

Service for managing Fulfillments.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Fulfillments::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 399
def self.fulfillments version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Fulfillments).const_get(:Client).new(&block)
end
intents(version: :v2, &block) click to toggle source

Create a new client object for Intents.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Intents::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Intents/Client.html) for version V2 of the API. However, you can specify 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.

## About Intents

Service for managing Intents.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Intents::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 126
def self.intents version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Intents).const_get(:Client).new(&block)
end
knowledge_bases(version: :v2, &block) click to toggle source

Create a new client object for KnowledgeBases.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::KnowledgeBases::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/KnowledgeBases/Client.html) for version V2 of the API. However, you can specify 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.

## About KnowledgeBases

Service for managing KnowledgeBases.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [KnowledgeBases::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 459
def self.knowledge_bases version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:KnowledgeBases).const_get(:Client).new(&block)
end
participants(version: :v2, &block) click to toggle source

Create a new client object for Participants.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Participants::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Participants/Client.html) for version V2 of the API. However, you can specify 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.

## About Participants

Service for managing Participants.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Participants::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 249
def self.participants version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Participants).const_get(:Client).new(&block)
end
session_entity_types(version: :v2, &block) click to toggle source

Create a new client object for SessionEntityTypes.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::SessionEntityTypes::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/SessionEntityTypes/Client.html) for version V2 of the API. However, you can specify 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.

## About SessionEntityTypes

Service for managing SessionEntityTypes.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [SessionEntityTypes::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 186
def self.session_entity_types version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:SessionEntityTypes).const_get(:Client).new(&block)
end
sessions(version: :v2, &block) click to toggle source

Create a new client object for Sessions.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Sessions::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Sessions/Client.html) for version V2 of the API. However, you can specify 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.

## About Sessions

A service used for session interactions.

For more information, see the [API interactions guide](cloud.google.com/dialogflow/docs/api-overview).

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Sessions::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 219
def self.sessions version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Sessions).const_get(:Client).new(&block)
end
versions(version: :v2, &block) click to toggle source

Create a new client object for Versions.

By default, this returns an instance of [Google::Cloud::Dialogflow::V2::Versions::Client](googleapis.dev/ruby/google-cloud-dialogflow-v2/latest/Google/Cloud/Dialogflow/V2/Versions/Client.html) for version V2 of the API. However, you can specify 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.

## About Versions

Service for managing Versions.

@param version [::String, ::Symbol] The API version to connect to. Optional.

Defaults to `:v2`.

@return [Versions::Client] A client object for the specified version.

# File lib/google/cloud/dialogflow.rb, line 489
def self.versions version: :v2, &block
  require "google/cloud/dialogflow/#{version.to_s.downcase}"

  package_name = Google::Cloud::Dialogflow
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::Dialogflow.const_get package_name
  package_module.const_get(:Versions).const_get(:Client).new(&block)
end