Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client (v1.43.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.

Client for the ReasoningEngineExecutionService service.

A service for executing queries on Reasoning Engine.

Inherits

  • Object

Includes

Methods

.configure

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

Configure the ReasoningEngineExecutionService Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all ReasoningEngineExecutionService clients
::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.configure do |config|
  config.timeout = 10.0
end

#async_query_reasoning_engine

def async_query_reasoning_engine(request, options = nil) -> ::Gapic::Operation
def async_query_reasoning_engine(name: nil, input_gcs_uri: nil, output_gcs_uri: nil) -> ::Gapic::Operation

Async query using a reasoning engine.

Overloads 
def async_query_reasoning_engine(request, options = nil) -> ::Gapic::Operation
Pass arguments to async_query_reasoning_engine via a request object, either of type AsyncQueryReasoningEngineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest, ::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 async_query_reasoning_engine(name: nil, input_gcs_uri: nil, output_gcs_uri: nil) -> ::Gapic::Operation
Pass arguments to async_query_reasoning_engine 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
  • name (::String) — Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
  • input_gcs_uri (::String) — Optional. Input Cloud Storage URI for the Async query.
  • output_gcs_uri (::String) — Optional. Output Cloud Storage URI for the Async query.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::AsyncQueryReasoningEngineRequest.new

# Call the async_query_reasoning_engine method.
result = client.async_query_reasoning_engine 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

#cancel_async_query_reasoning_engine

def cancel_async_query_reasoning_engine(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse
def cancel_async_query_reasoning_engine(name: nil, operation_name: nil) -> ::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse

Cancels an AsyncQueryReasoningEngine operation.

Overloads 
def cancel_async_query_reasoning_engine(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse
Pass arguments to cancel_async_query_reasoning_engine via a request object, either of type CancelAsyncQueryReasoningEngineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest, ::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 cancel_async_query_reasoning_engine(name: nil, operation_name: nil) -> ::Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse
Pass arguments to cancel_async_query_reasoning_engine 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
  • name (::String) — Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
  • operation_name (::String) — Required. The name of the longrunning operation returned from AsyncQueryReasoningEngine. Format: projects/{project}/locations/{location}/operations/{operation}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::CancelAsyncQueryReasoningEngineResponse.
p result

#configure

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

Configure the ReasoningEngineExecutionService 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
Returns

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Client

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

Returns
  • (Google::Iam::V1::IAMPolicy::Client)

#initialize

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

Create a new ReasoningEngineExecutionService client object.

Yields
  • (config) — Configure the ReasoningEngineExecutionService client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new do |config|
  config.timeout = 10.0
end

#location_client

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

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

Returns
  • (Google::Cloud::Location::Locations::Client)

#logger

def logger() -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#operations_client

def operations_client() -> ::Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Operations

Get the associated client for long-running operations.

Returns

#query_reasoning_engine

def query_reasoning_engine(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::QueryReasoningEngineResponse
def query_reasoning_engine(name: nil, input: nil, class_method: nil) -> ::Google::Cloud::AIPlatform::V1::QueryReasoningEngineResponse

Queries using a reasoning engine.

Overloads 
def query_reasoning_engine(request, options = nil) -> ::Google::Cloud::AIPlatform::V1::QueryReasoningEngineResponse
Pass arguments to query_reasoning_engine via a request object, either of type QueryReasoningEngineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::QueryReasoningEngineRequest, ::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 query_reasoning_engine(name: nil, input: nil, class_method: nil) -> ::Google::Cloud::AIPlatform::V1::QueryReasoningEngineResponse
Pass arguments to query_reasoning_engine 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
  • name (::String) — Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
  • input (::Google::Protobuf::Struct, ::Hash) — Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
  • class_method (::String) — Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::QueryReasoningEngineRequest.new

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

# The returned object is of type Google::Cloud::AIPlatform::V1::QueryReasoningEngineResponse.
p result

#stream_query_reasoning_engine

def stream_query_reasoning_engine(request, options = nil) -> ::Enumerable<::Google::Api::HttpBody>
def stream_query_reasoning_engine(name: nil, input: nil, class_method: nil) -> ::Enumerable<::Google::Api::HttpBody>

Streams queries using a reasoning engine.

Overloads 
def stream_query_reasoning_engine(request, options = nil) -> ::Enumerable<::Google::Api::HttpBody>
Pass arguments to stream_query_reasoning_engine via a request object, either of type StreamQueryReasoningEngineRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::AIPlatform::V1::StreamQueryReasoningEngineRequest, ::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 stream_query_reasoning_engine(name: nil, input: nil, class_method: nil) -> ::Enumerable<::Google::Api::HttpBody>
Pass arguments to stream_query_reasoning_engine 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
  • name (::String) — Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}
  • input (::Google::Protobuf::Struct, ::Hash) — Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.
  • class_method (::String) — Optional. Class method to be used for the stream query. It is optional and defaults to "stream_query" if unspecified.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/ai_platform/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AIPlatform::V1::ReasoningEngineExecutionService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AIPlatform::V1::StreamQueryReasoningEngineRequest.new

# Call the stream_query_reasoning_engine method to start streaming.
output = client.stream_query_reasoning_engine request

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Api::HttpBody
output.each do |current_response|
  p current_response
end

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)