Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Tools::Rest::Client (v1.13.0)

Reference documentation and code samples for the Dialogflow V2 API class Google::Cloud::Dialogflow::V2::Tools::Rest::Client.

REST client for the Tools service.

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

Inherits

Object

Includes

Google::Cloud::Dialogflow::V2::Tools::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Tools Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

# Modify the configuration for all Tools clients
::Google::Cloud::Dialogflow::V2::Tools::Rest::Client.configure do |config|
  config.timeout = 10.0
end

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Tools 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 Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_tool

def create_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool
def create_tool(parent: nil, tool: nil, tool_id: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Creates a tool.

Overloads

def create_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to create_tool via a request object, either of type CreateToolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::V2::CreateToolRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def create_tool(parent: nil, tool: nil, tool_id: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to create_tool 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).

Parameters

parent (::String) — Required. The project/location to create tool for. Format: projects/<Project ID>/locations/<Location ID>
tool (::Google::Cloud::Dialogflow::V2::Tool, ::Hash) — Required. The tool to create.
tool_id (::String) —
Optional. The ID to use for the tool, which will become the final component of the tool's resource name.

The tool ID must be compliant with the regression formula [a-zA-Z][a-zA-Z0-9_-]* with the characters length in range of [3,64]. If the field is not provide, an Id will be auto-generated. If the field is provided, the caller is responsible for
1. the uniqueness of the ID, otherwise the request will be rejected.
2. the consistency for whether to use custom ID or not under a project to better ensure uniqueness.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dialogflow::V2::Tool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dialogflow::V2::Tool)

Raises

(::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::Tools::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::CreateToolRequest.new

# Call the create_tool method.
result = client.create_tool request

# The returned object is of type Google::Cloud::Dialogflow::V2::Tool.
p result

#delete_tool

def delete_tool(request, options = nil) -> ::Google::Protobuf::Empty
def delete_tool(name: nil) -> ::Google::Protobuf::Empty

Deletes a tool.

Overloads

def delete_tool(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_tool via a request object, either of type DeleteToolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::V2::DeleteToolRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def delete_tool(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to delete_tool 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).

Parameter

name (::String) — Required. The tool resource name to delete. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Protobuf::Empty)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Protobuf::Empty)

Raises

(::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::Tools::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::DeleteToolRequest.new

# Call the delete_tool method.
result = client.delete_tool request

# The returned object is of type Google::Protobuf::Empty.
p result

#get_tool

def get_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool
def get_tool(name: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Retrieves a tool.

Overloads

def get_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to get_tool via a request object, either of type GetToolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::V2::GetToolRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def get_tool(name: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to get_tool 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).

Parameter

name (::String) — Required. The tool resource name to retrieve. Format: projects/<Project ID>/locations/<Location ID>/tools/<Tool ID>

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dialogflow::V2::Tool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dialogflow::V2::Tool)

Raises

(::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::Tools::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::GetToolRequest.new

# Call the get_tool method.
result = client.get_tool request

# The returned object is of type Google::Cloud::Dialogflow::V2::Tool.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Tools REST client object.

Yields

(config) — Configure the Tools client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# Create a client using the default configuration
client = ::Google::Cloud::Dialogflow::V2::Tools::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Dialogflow::V2::Tools::Rest::Client.new do |config|
  config.timeout = 10.0
end

#list_tools

def list_tools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>
def list_tools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>

Lists tools.

Overloads

def list_tools(request, options = nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>

Pass arguments to list_tools via a request object, either of type ListToolsRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::V2::ListToolsRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def list_tools(parent: nil, page_size: nil, page_token: nil) -> ::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>

Pass arguments to list_tools 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).

Parameters

parent (::String) — Required. The project/location to list tools for. Format: projects/<Project ID>/locations/<Location ID>
page_size (::Integer) — Optional. Maximum number of conversation models to return in a single page. Default to 10.
page_token (::String) — Optional. The next_page_token value returned from a previous list request.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Gapic::Rest::PagedEnumerable<::Google::Cloud::Dialogflow::V2::Tool>)

Raises

(::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::Tools::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::ListToolsRequest.new

# Call the list_tools method.
result = client.list_tools 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::Tool.
  p item
end

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

Get the associated client for mix-in of the Locations.

Returns

(Google::Cloud::Location::Locations::Rest::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns

(Logger)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

(String)

#update_tool

def update_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool
def update_tool(tool: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Updates a tool.

Overloads

def update_tool(request, options = nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to update_tool via a request object, either of type UpdateToolRequest or an equivalent Hash.

Parameters

request (::Google::Cloud::Dialogflow::V2::UpdateToolRequest, ::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.
options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def update_tool(tool: nil, update_mask: nil) -> ::Google::Cloud::Dialogflow::V2::Tool

Pass arguments to update_tool 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).

Parameters

tool (::Google::Cloud::Dialogflow::V2::Tool, ::Hash) — Required. The tool to update. The name field of tool is to identify the tool to update.
update_mask (::Google::Protobuf::FieldMask, ::Hash) — Optional. The list of fields to update.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Dialogflow::V2::Tool)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Dialogflow::V2::Tool)

Raises

(::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::Tools::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Dialogflow::V2::UpdateToolRequest.new

# Call the update_tool method.
result = client.update_tool request

# The returned object is of type Google::Cloud::Dialogflow::V2::Tool.
p result

Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Tools::Rest::Client (v1.13.0) Stay organized with collections Save and categorize content based on your preferences.

Inherits

Includes

Methods

.configure

#configure

#create_tool

#delete_tool

#get_tool

#initialize

#list_tools

#location_client

#logger

#universe_domain

#update_tool

Dialogflow V2 API - Class Google::Cloud::Dialogflow::V2::Tools::Rest::Client (v1.13.0)