# frozen_string_literal: true
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "gapic/common"
require "gapic/config"
require "gapic/config/method"
require "google/cloud/errors"
require "google/cloud/dialogflow/v2/version"
require "google/cloud/dialogflow/v2/agent_pb"
require "google/cloud/dialogflow/v2/agents/credentials"
require "google/cloud/dialogflow/v2/agents/paths"
require "google/cloud/dialogflow/v2/agents/operations"
module Google
module Cloud
module Dialogflow
module V2
module Agents
##
# Client for the Agents service.
#
# Agents are best described as Natural Language Understanding (NLU) modules
# that transform user requests into actionable data. You can include agents
# in your app, product, or service to determine user intent and respond to the
# user in a natural way.
#
# After you create an agent, you can add {Google::Cloud::Dialogflow::V2::Intents::Client Intents}, {Google::Cloud::Dialogflow::V2::Contexts::Client Contexts},
# [Entity Types][google.cloud.dialogflow.v2.EntityTypes], {Google::Cloud::Dialogflow::V2::WebhookRequest Webhooks}, and so on to
# manage the flow of a conversation and match user input to predefined intents
# and actions.
#
# You can create an agent using both Dialogflow Standard Edition and
# Dialogflow Enterprise Edition. For details, see
# [Dialogflow
# Editions](https://cloud.google.com/dialogflow/docs/editions).
#
# You can save your agent for backup or versioning by exporting the agent by
# using the {Google::Cloud::Dialogflow::V2::Agents::Client#export_agent ExportAgent} method. You can import a saved
# agent by using the {Google::Cloud::Dialogflow::V2::Agents::Client#import_agent ImportAgent} method.
#
# Dialogflow provides several
# [prebuilt
# agents](https://cloud.google.com/dialogflow/docs/agents-prebuilt)
# for common conversation scenarios such as determining a date and time,
# converting currency, and so on.
#
# For more information about agents, see the
# [Dialogflow
# documentation](https://cloud.google.com/dialogflow/docs/agents-overview).
#
class Client
include Paths
# @private
attr_reader :agents_stub
##
# Configure the Agents Client class.
#
# See {Google::Cloud::Dialogflow::V2::Agents::Client::Configuration}
# for a description of the configuration fields.
#
# ## Example
#
# To modify the configuration for all Agents clients:
#
# Google::Cloud::Dialogflow::V2::Agents::Client.configure do |config|
# config.timeout = 10_000
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "Dialogflow", "V2"]
parent_config = while namespace.any?
parent_name = namespace.join "::"
parent_const = const_get parent_name
break parent_const.configure if parent_const&.respond_to? :configure
namespace.pop
end
default_config = Client::Configuration.new parent_config
default_config.rpcs.get_agent.timeout = 60.0
default_config.rpcs.get_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.set_agent.timeout = 60.0
default_config.rpcs.set_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.delete_agent.timeout = 60.0
default_config.rpcs.delete_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.search_agents.timeout = 60.0
default_config.rpcs.search_agents.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.train_agent.timeout = 60.0
default_config.rpcs.train_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.export_agent.timeout = 60.0
default_config.rpcs.export_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config.rpcs.import_agent.timeout = 60.0
default_config.rpcs.restore_agent.timeout = 60.0
default_config.rpcs.restore_agent.retry_policy = {
initial_delay: 0.1,
max_delay: 60.0,
multiplier: 1.3,
retry_codes: ["UNAVAILABLE", "DEADLINE_EXCEEDED"]
}
default_config
end
yield @configure if block_given?
@configure
end
##
# Configure the Agents Client instance.
#
# The configuration is set to the derived mode, meaning that values can be changed,
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
# should be made on {Client.configure}.
#
# See {Google::Cloud::Dialogflow::V2::Agents::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# Create a new Agents client object.
#
# ## Examples
#
# To create a new Agents client with the default
# configuration:
#
# client = Google::Cloud::Dialogflow::V2::Agents::Client.new
#
# To create a new Agents client with a custom
# configuration:
#
# client = Google::Cloud::Dialogflow::V2::Agents::Client.new do |config|
# config.timeout = 10_000
# end
#
# @yield [config] Configure the Agents client.
# @yieldparam config [Client::Configuration]
#
def initialize
# These require statements are intentionally placed here to initialize
# the gRPC module only when it's required.
# See https://github.com/googleapis/toolkit/issues/446
require "gapic/grpc"
require "google/cloud/dialogflow/v2/agent_services_pb"
# Create the configuration object
@config = Configuration.new Client.configure
# Yield the configuration if needed
yield @config if block_given?
# Create credentials
credentials = @config.credentials
credentials ||= Credentials.default scope: @config.scope
if credentials.is_a?(String) || credentials.is_a?(Hash)
credentials = Credentials.new credentials, scope: @config.scope
end
@quota_project_id = credentials.respond_to?(:quota_project_id) ? credentials.quota_project_id : nil
@operations_client = Operations.new do |config|
config.credentials = credentials
end
@agents_stub = Gapic::ServiceStub.new(
Google::Cloud::Dialogflow::V2::Agents::Stub,
credentials: credentials,
endpoint: @config.endpoint,
channel_args: @config.channel_args,
interceptors: @config.interceptors
)
end
# Service calls
##
# Retrieves the specified agent.
#
# @overload get_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::GetAgentRequest | Hash]
# Retrieves the specified agent.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_agent(parent: nil)
# @param parent [String]
# Required. The project that the agent to fetch is associated with.
# Format: `projects/<Project ID>`.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::Dialogflow::V2::Agent]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::Dialogflow::V2::Agent]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.get_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :get_agent, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Creates/updates the specified agent.
#
# @overload set_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::SetAgentRequest | Hash]
# Creates/updates the specified agent.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload set_agent(agent: nil, update_mask: nil)
# @param agent [Google::Cloud::Dialogflow::V2::Agent | Hash]
# Required. The agent to update.
# @param update_mask [Google::Protobuf::FieldMask | Hash]
# Optional. The mask to control which fields get updated.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::Dialogflow::V2::Agent]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::Dialogflow::V2::Agent]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def set_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::SetAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.set_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"agent.parent" => request.agent.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.set_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.set_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :set_agent, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Deletes the specified agent.
#
# @overload delete_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::DeleteAgentRequest | Hash]
# Deletes the specified agent.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload delete_agent(parent: nil)
# @param parent [String]
# Required. The project that the agent to delete is associated with.
# Format: `projects/<Project ID>`.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Protobuf::Empty]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Protobuf::Empty]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def delete_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::DeleteAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.delete_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.delete_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :delete_agent, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Returns the list of agents.
#
# Since there is at most one conversational agent per project, this method is
# useful primarily for listing all agents across projects the caller has
# access to. One can achieve that with a wildcard project collection id "-".
# Refer to [List
# Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
#
# @overload search_agents(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::SearchAgentsRequest | Hash]
# Returns the list of agents.
#
# Since there is at most one conversational agent per project, this method is
# useful primarily for listing all agents across projects the caller has
# access to. One can achieve that with a wildcard project collection id "-".
# Refer to [List
# Sub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload search_agents(parent: nil, page_size: nil, page_token: nil)
# @param parent [String]
# Required. The project to list agents from.
# Format: `projects/<Project ID or '-'>`.
# @param page_size [Integer]
# Optional. The maximum number of items to return in a single page. By
# default 100 and at most 1000.
# @param page_token [String]
# The next_page_token value returned from a previous list request.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent>]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::PagedEnumerable<Google::Cloud::Dialogflow::V2::Agent>]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def search_agents request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::SearchAgentsRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.search_agents.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.search_agents.timeout,
metadata: metadata,
retry_policy: @config.rpcs.search_agents.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :search_agents, request, options: options do |response, operation|
response = Gapic::PagedEnumerable.new @agents_stub, :search_agents, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Trains the specified agent.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
#
# @overload train_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::TrainAgentRequest | Hash]
# Trains the specified agent.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload train_agent(parent: nil)
# @param parent [String]
# Required. The project that the agent to train is associated with.
# Format: `projects/<Project ID>`.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::Operation]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::Operation]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def train_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::TrainAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.train_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.train_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.train_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :train_agent, request, options: options do |response, operation|
response = Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Exports the specified agent to a ZIP file.
#
# Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
#
# @overload export_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::ExportAgentRequest | Hash]
# Exports the specified agent to a ZIP file.
#
# Operation <response: {Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}>
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload export_agent(parent: nil, agent_uri: nil)
# @param parent [String]
# Required. The project that the agent to export is associated with.
# Format: `projects/<Project ID>`.
# @param agent_uri [String]
# Required. The [Google Cloud Storage](https://cloud.google.com/storage/docs/)
# URI to export the agent to.
# The format of this URI must be `gs://<bucket-name>/<object-name>`.
# If left unspecified, the serialized agent is returned inline.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::Operation]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::Operation]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def export_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ExportAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.export_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :export_agent, request, options: options do |response, operation|
response = Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Imports the specified agent from a ZIP file.
#
# Uploads new intents and entity types without deleting the existing ones.
# Intents and entity types with the same name are replaced with the new
# versions from ImportAgentRequest.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
#
# @overload import_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::ImportAgentRequest | Hash]
# Imports the specified agent from a ZIP file.
#
# Uploads new intents and entity types without deleting the existing ones.
# Intents and entity types with the same name are replaced with the new
# versions from ImportAgentRequest.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload import_agent(parent: nil, agent_uri: nil, agent_content: nil)
# @param parent [String]
# Required. The project that the agent to import is associated with.
# Format: `projects/<Project ID>`.
# @param agent_uri [String]
# The URI to a Google Cloud Storage file containing the agent to import.
# Note: The URI must start with "gs://".
# @param agent_content [String]
# Zip compressed raw byte content for agent.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::Operation]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::Operation]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def import_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::ImportAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.import_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.import_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.import_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :import_agent, request, options: options do |response, operation|
response = Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Restores the specified agent from a ZIP file.
#
# Replaces the current agent version with a new one. All the intents and
# entity types in the older version are deleted.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
#
# @overload restore_agent(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::RestoreAgentRequest | Hash]
# Restores the specified agent from a ZIP file.
#
# Replaces the current agent version with a new one. All the intents and
# entity types in the older version are deleted.
#
# Operation <response: {Google::Protobuf::Empty google.protobuf.Empty}>
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload restore_agent(parent: nil, agent_uri: nil, agent_content: nil)
# @param parent [String]
# Required. The project that the agent to restore is associated with.
# Format: `projects/<Project ID>`.
# @param agent_uri [String]
# The URI to a Google Cloud Storage file containing the agent to restore.
# Note: The URI must start with "gs://".
# @param agent_content [String]
# Zip compressed raw byte content for agent.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Gapic::Operation]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Gapic::Operation]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def restore_agent request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::RestoreAgentRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.restore_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.restore_agent.timeout,
metadata: metadata,
retry_policy: @config.rpcs.restore_agent.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :restore_agent, request, options: options do |response, operation|
response = Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Gets agent validation result. Agent validation is performed during
# training time and is updated automatically when training is completed.
#
# @overload get_validation_result(request, options = nil)
# @param request [Google::Cloud::Dialogflow::V2::GetValidationResultRequest | Hash]
# Gets agent validation result. Agent validation is performed during
# training time and is updated automatically when training is completed.
# @param options [Gapic::CallOptions, Hash]
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
#
# @overload get_validation_result(parent: nil, language_code: nil)
# @param parent [String]
# Required. The project that the agent is associated with.
# Format: `projects/<Project ID>`.
# @param language_code [String]
# Optional. The language for which you want a validation result. If not
# specified, the agent's default language is used. [Many
# languages](https://cloud.google.com/dialogflow/docs/reference/language)
# are supported. Note: languages must be enabled in the agent before they can
# be used.
#
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [Google::Cloud::Dialogflow::V2::ValidationResult]
# @yieldparam operation [GRPC::ActiveCall::Operation]
#
# @return [Google::Cloud::Dialogflow::V2::ValidationResult]
#
# @raise [Google::Cloud::Error] if the RPC is aborted.
#
def get_validation_result request, options = nil
raise ArgumentError, "request must be provided" if request.nil?
request = Gapic::Protobuf.coerce request, to: Google::Cloud::Dialogflow::V2::GetValidationResultRequest
# Converts hash and nil to an options object
options = Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.get_validation_result.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
metadata[:"x-goog-api-client"] ||= Gapic::Headers.x_goog_api_client \
lib_name: @config.lib_name, lib_version: @config.lib_version,
gapic_version: ::Google::Cloud::Dialogflow::V2::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {
"parent" => request.parent
}
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_validation_result.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_validation_result.retry_policy
options.apply_defaults metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.call_rpc :get_validation_result, request, options: options do |response, operation|
yield response, operation if block_given?
return response
end
rescue GRPC::BadStatus => e
raise Google::Cloud::Error.from_error(e)
end
##
# Configuration class for the Agents API.
#
# This class represents the configuration for Agents,
# providing control over timeouts, retry behavior, logging, transport
# parameters, and other low-level controls. Certain parameters can also be
# applied individually to specific RPCs. See
# {Google::Cloud::Dialogflow::V2::Agents::Client::Configuration::Rpcs}
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
# # Examples
#
# To modify the global config, setting the timeout for get_agent
# to 20 seconds, and all remaining timeouts to 10 seconds:
#
# Google::Cloud::Dialogflow::V2::Agents::Client.configure do |config|
# config.timeout = 10_000
# config.rpcs.get_agent.timeout = 20_000
# end
#
# To apply the above configuration only to a new client:
#
# client = Google::Cloud::Dialogflow::V2::Agents::Client.new do |config|
# config.timeout = 10_000
# config.rpcs.get_agent.timeout = 20_000
# end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"dialogflow.googleapis.com"`.
# @return [String]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [Array<String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [Array<GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in milliseconds.
# @return [Numeric]
# @!attribute [rw] metadata
# Additional gRPC headers to be sent with the call.
# @return [Hash{Symbol=>String}]
# @!attribute [rw] retry_policy
# 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 [Hash]
#
class Configuration
extend Gapic::Config
config_attr :endpoint, "dialogflow.googleapis.com", String
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, String, Array, nil
config_attr :lib_name, nil, String, nil
config_attr :lib_version, nil, String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, Hash, nil)
config_attr :interceptors, nil, Array, nil
config_attr :timeout, nil, Numeric, nil
config_attr :metadata, nil, Hash, nil
config_attr :retry_policy, nil, Hash, Proc, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
Rpcs.new parent_rpcs
end
end
##
# Configuration RPC class for the Agents API.
#
# Includes fields providing the configuration for each RPC in this service.
# Each configuration object is of type `Gapic::Config::Method` and includes
# the following configuration fields:
#
# * `timeout` (*type:* `Numeric`) - The call timeout in milliseconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
# include 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.
#
class Rpcs
##
# RPC-specific configuration for `get_agent`
# @return [Gapic::Config::Method]
#
attr_reader :get_agent
##
# RPC-specific configuration for `set_agent`
# @return [Gapic::Config::Method]
#
attr_reader :set_agent
##
# RPC-specific configuration for `delete_agent`
# @return [Gapic::Config::Method]
#
attr_reader :delete_agent
##
# RPC-specific configuration for `search_agents`
# @return [Gapic::Config::Method]
#
attr_reader :search_agents
##
# RPC-specific configuration for `train_agent`
# @return [Gapic::Config::Method]
#
attr_reader :train_agent
##
# RPC-specific configuration for `export_agent`
# @return [Gapic::Config::Method]
#
attr_reader :export_agent
##
# RPC-specific configuration for `import_agent`
# @return [Gapic::Config::Method]
#
attr_reader :import_agent
##
# RPC-specific configuration for `restore_agent`
# @return [Gapic::Config::Method]
#
attr_reader :restore_agent
##
# RPC-specific configuration for `get_validation_result`
# @return [Gapic::Config::Method]
#
attr_reader :get_validation_result
# @private
def initialize parent_rpcs = nil
get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
@get_agent = Gapic::Config::Method.new get_agent_config
set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
@set_agent = Gapic::Config::Method.new set_agent_config
delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
@delete_agent = Gapic::Config::Method.new delete_agent_config
search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
@search_agents = Gapic::Config::Method.new search_agents_config
train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
@train_agent = Gapic::Config::Method.new train_agent_config
export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
@export_agent = Gapic::Config::Method.new export_agent_config
import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
@import_agent = Gapic::Config::Method.new import_agent_config
restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
@restore_agent = Gapic::Config::Method.new restore_agent_config
get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
@get_validation_result = Gapic::Config::Method.new get_validation_result_config
yield self if block_given?
end
end
end
end
end
end
end
end
end
# rubocop:disable Lint/HandleExceptions
# Once client is loaded, load helpers.rb if it exists.
begin
require "google/cloud/dialogflow/v2/agents/helpers"
rescue LoadError
end
# rubocop:enable Lint/HandleExceptions