# frozen_string_literal: true
# Copyright 2023 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 "google/cloud/errors"
require "google/cloud/dialogflow/v2/agent_pb"
require "google/cloud/dialogflow/v2/agents/rest/service_stub"
require "google/cloud/location/rest"
module Google
module Cloud
module Dialogflow
module V2
module Agents
module Rest
##
# REST client for the Agents service.
#
# Service for managing {::Google::Cloud::Dialogflow::V2::Agent Agents}.
#
class Client
# @private
DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
include Paths
# @private
attr_reader :agents_stub
##
# Configure the Agents Client class.
#
# See {::Google::Cloud::Dialogflow::V2::Agents::Rest::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all Agents clients
# ::Google::Cloud::Dialogflow::V2::Agents::Rest::Client.configure do |config|
# config.timeout = 10.0
# 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.timeout = 60.0
default_config.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
}
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::Rest::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
##
# The effective universe domain
#
# @return [String]
#
def universe_domain
@agents_stub.universe_domain
end
##
# Create a new Agents REST client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Agents client.
# @yieldparam config [Client::Configuration]
#
def initialize
# Create the configuration object
@config = Configuration.new Client.configure
# Yield the configuration if needed
yield @config if block_given?
# Create credentials
credentials = @config.credentials
# Use self-signed JWT if the endpoint is unchanged from default,
# but only if the default endpoint does not have a region prefix.
enable_self_signed_jwt = @config.endpoint.nil? ||
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
!@config.endpoint.split(".").first.include?("-"))
credentials ||= Credentials.default scope: @config.scope,
enable_self_signed_jwt: enable_self_signed_jwt
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
credentials = Credentials.new credentials, scope: @config.scope
end
@quota_project_id = @config.quota_project
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
@operations_client = ::Google::Cloud::Dialogflow::V2::Agents::Rest::Operations.new do |config|
config.credentials = credentials
config.quota_project = @quota_project_id
config.endpoint = @config.endpoint
config.universe_domain = @config.universe_domain
end
@location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
config.credentials = credentials
config.quota_project = @quota_project_id
config.endpoint = @config.endpoint
config.universe_domain = @config.universe_domain
config.bindings_override = @config.bindings_override
end
@agents_stub = ::Google::Cloud::Dialogflow::V2::Agents::Rest::ServiceStub.new(
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
credentials: credentials
)
end
##
# Get the associated client for long-running operations.
#
# @return [::Google::Cloud::Dialogflow::V2::Agents::Rest::Operations]
#
attr_reader :operations_client
##
# Get the associated client for mix-in of the Locations.
#
# @return [Google::Cloud::Location::Locations::Rest::Client]
#
attr_reader :location_client
# Service calls
##
# Retrieves the specified agent.
#
# @overload get_agent(request, options = nil)
# Pass arguments to `get_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::GetAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::GetAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @overload get_agent(parent: nil)
# Pass arguments to `get_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The project that the agent to fetch is associated with.
# Format: `projects/<Project ID>`.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Dialogflow::V2::Agent]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::Agent]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::GetAgentRequest.new
#
# # Call the get_agent method.
# result = client.get_agent request
#
# # The returned object is of type Google::Cloud::Dialogflow::V2::Agent.
# p result
#
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
call_metadata = @config.rpcs.get_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.get_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.get_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.get_agent request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Creates/updates the specified agent.
#
# Note: You should always train an agent prior to sending it queries. See the
# [training
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
#
# @overload set_agent(request, options = nil)
# Pass arguments to `set_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::SetAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::SetAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `set_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Dialogflow::V2::Agent]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::Agent]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::SetAgentRequest.new
#
# # Call the set_agent method.
# result = client.set_agent request
#
# # The returned object is of type Google::Cloud::Dialogflow::V2::Agent.
# p result
#
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
call_metadata = @config.rpcs.set_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.set_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.set_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.set_agent request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Deletes the specified agent.
#
# @overload delete_agent(request, options = nil)
# Pass arguments to `delete_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::DeleteAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::DeleteAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @overload delete_agent(parent: nil)
# Pass arguments to `delete_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The project that the agent to delete is associated with.
# Format: `projects/<Project ID>`.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Protobuf::Empty]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Protobuf::Empty]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::DeleteAgentRequest.new
#
# # Call the delete_agent method.
# result = client.delete_agent request
#
# # The returned object is of type Google::Protobuf::Empty.
# p result
#
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
call_metadata = @config.rpcs.delete_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.delete_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.delete_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.delete_agent request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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)
# Pass arguments to `search_agents` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::SearchAgentsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::SearchAgentsRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `search_agents` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Agent>]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Agent>]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::SearchAgentsRequest.new
#
# # Call the search_agents method.
# result = client.search_agents request
#
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
# # over elements, and API calls will be issued to fetch pages as needed.
# result.each do |item|
# # Each element is of type ::Google::Cloud::Dialogflow::V2::Agent.
# p item
# end
#
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
call_metadata = @config.rpcs.search_agents.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.search_agents.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.search_agents.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.search_agents request, options do |result, operation|
result = ::Gapic::Rest::PagedEnumerable.new @agents_stub, :search_agents, "agents", request, result, options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Trains the specified agent.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`: An empty [Struct
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
# - `response`: An [Empty
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
#
# Note: You should always train an agent prior to sending it queries. See the
# [training
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
#
# @overload train_agent(request, options = nil)
# Pass arguments to `train_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::TrainAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::TrainAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @param options [::Gapic::CallOptions, ::Hash]
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
#
# @overload train_agent(parent: nil)
# Pass arguments to `train_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @param parent [::String]
# Required. The project that the agent to train is associated with.
# Format: `projects/<Project ID>`.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::TrainAgentRequest.new
#
# # Call the train_agent method.
# result = client.train_agent request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
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
call_metadata = @config.rpcs.train_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.train_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.train_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.train_agent request, options do |result, operation|
result = ::Gapic::Operation.new result, @operations_client, options: options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Exports the specified agent to a ZIP file.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`: An empty [Struct
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
# - `response`:
# {::Google::Cloud::Dialogflow::V2::ExportAgentResponse ExportAgentResponse}
#
# @overload export_agent(request, options = nil)
# Pass arguments to `export_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::ExportAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::ExportAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `export_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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.
#
# Dialogflow performs a write operation for the Cloud Storage object
# on the caller's behalf, so your request authentication must
# have write permissions for the object. For more information, see
# [Dialogflow access
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::ExportAgentRequest.new
#
# # Call the export_agent method.
# result = client.export_agent request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
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
call_metadata = @config.rpcs.export_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.export_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.export_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.export_agent request, options do |result, operation|
result = ::Gapic::Operation.new result, @operations_client, options: options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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
# {::Google::Cloud::Dialogflow::V2::ImportAgentRequest ImportAgentRequest}. After
# the import, the imported draft agent will be trained automatically (unless
# disabled in agent settings). However, once the import is done, training may
# not be completed yet. Please call
# {::Google::Cloud::Dialogflow::V2::Agents::Rest::Client#train_agent TrainAgent} and wait for the
# operation it returns in order to train explicitly.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`: An empty [Struct
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
# - `response`: An [Empty
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
#
# The operation only tracks when importing is complete, not when it is done
# training.
#
# Note: You should always train an agent prior to sending it queries. See the
# [training
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
#
# @overload import_agent(request, options = nil)
# Pass arguments to `import_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::ImportAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::ImportAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `import_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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://".
#
# Dialogflow performs a read operation for the Cloud Storage object
# on the caller's behalf, so your request authentication must
# have read permissions for the object. For more information, see
# [Dialogflow access
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
# @param agent_content [::String]
# Zip compressed raw byte content for agent.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::ImportAgentRequest.new
#
# # Call the import_agent method.
# result = client.import_agent request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
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
call_metadata = @config.rpcs.import_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.import_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.import_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.import_agent request, options do |result, operation|
result = ::Gapic::Operation.new result, @operations_client, options: options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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. After the restore, the
# restored draft agent will be trained automatically (unless disabled in
# agent settings). However, once the restore is done, training may not be
# completed yet. Please call
# {::Google::Cloud::Dialogflow::V2::Agents::Rest::Client#train_agent TrainAgent} and wait for the
# operation it returns in order to train explicitly.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/es/docs/how/long-running-operations).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`: An empty [Struct
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#struct)
# - `response`: An [Empty
# message](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#empty)
#
# The operation only tracks when restoring is complete, not when it is done
# training.
#
# Note: You should always train an agent prior to sending it queries. See the
# [training
# documentation](https://cloud.google.com/dialogflow/es/docs/training).
#
# @overload restore_agent(request, options = nil)
# Pass arguments to `restore_agent` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::RestoreAgentRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::RestoreAgentRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `restore_agent` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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://".
#
# Dialogflow performs a read operation for the Cloud Storage object
# on the caller's behalf, so your request authentication must
# have read permissions for the object. For more information, see
# [Dialogflow access
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
# @param agent_content [::String]
# Zip compressed raw byte content for agent.
# @yield [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Gapic::Operation]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::RestoreAgentRequest.new
#
# # Call the restore_agent method.
# result = client.restore_agent request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
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
call_metadata = @config.rpcs.restore_agent.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.restore_agent.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.restore_agent.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.restore_agent request, options do |result, operation|
result = ::Gapic::Operation.new result, @operations_client, options: options
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => 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)
# Pass arguments to `get_validation_result` via a request object, either of type
# {::Google::Cloud::Dialogflow::V2::GetValidationResultRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::V2::GetValidationResultRequest, ::Hash]
# A request object representing the call parameters. Required. To specify no
# parameters, or to keep all the default parameter values, pass an empty Hash.
# @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)
# Pass arguments to `get_validation_result` via keyword arguments. Note that at
# least one keyword argument is required. To specify no parameters, or to keep all
# the default parameter values, pass an empty Hash as a request object (see above).
#
# @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 [result, operation] Access the result along with the TransportOperation object
# @yieldparam result [::Google::Cloud::Dialogflow::V2::ValidationResult]
# @yieldparam operation [::Gapic::Rest::TransportOperation]
#
# @return [::Google::Cloud::Dialogflow::V2::ValidationResult]
#
# @raise [::Google::Cloud::Error] if the REST call is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/v2"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::V2::GetValidationResultRequest.new
#
# # Call the get_validation_result method.
# result = client.get_validation_result request
#
# # The returned object is of type Google::Cloud::Dialogflow::V2::ValidationResult.
# p result
#
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
call_metadata = @config.rpcs.get_validation_result.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
call_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,
transports_version_send: [:rest]
call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
options.apply_defaults timeout: @config.rpcs.get_validation_result.timeout,
metadata: call_metadata,
retry_policy: @config.rpcs.get_validation_result.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@agents_stub.get_validation_result request, options do |result, operation|
yield result, operation if block_given?
return result
end
rescue ::Gapic::Rest::Error => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Configuration class for the Agents REST API.
#
# This class represents the configuration for Agents REST,
# 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::Rest::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.
#
# @example
#
# # 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::Rest::Client.configure do |config|
# config.timeout = 10.0
# config.rpcs.get_agent.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::Dialogflow::V2::Agents::Rest::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.get_agent.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# A custom service endpoint, as a hostname or hostname:port. The default is
# nil, indicating to use the default endpoint in the current universe domain.
# @return [::String,nil]
# @!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://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
# * (`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] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional 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]
# @!attribute [rw] quota_project
# A separate project against which to charge quota.
# @return [::String]
# @!attribute [rw] universe_domain
# The universe domain within which to make requests. This determines the
# default endpoint URL. The default value of nil uses the environment
# universe (usually the default "googleapis.com" universe).
# @return [::String,nil]
#
class Configuration
extend ::Gapic::Config
# @private
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
config_attr :endpoint, nil, ::String, nil
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
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 :timeout, nil, ::Numeric, nil
config_attr :metadata, nil, ::Hash, nil
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
config_attr :quota_project, nil, ::String, nil
config_attr :universe_domain, nil, ::String, nil
# @private
# Overrides for http bindings for the RPCs of this service
# are only used when this service is used as mixin, and only
# by the host service.
# @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
config_attr :bindings_override, {}, ::Hash, 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 defined?(@parent_config) && @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 seconds
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional 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
end