Vertex AI v1 API - Class ReasoningEngineExecutionServiceClient (3.72.0)

3.72.0 (latest) 3.71.0 3.70.0 3.69.0 3.68.0 3.67.0 3.66.0 3.65.0 3.64.0 3.63.0 3.62.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.51.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.39.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

public abstract class ReasoningEngineExecutionServiceClient

Reference documentation and code samples for the Vertex AI v1 API class ReasoningEngineExecutionServiceClient.

ReasoningEngineExecutionService client wrapper, for convenient use.

Inheritance

object > ReasoningEngineExecutionServiceClient

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Derived Types

ReasoningEngineExecutionServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for executing queries on Reasoning Engine.

Properties

AsyncQueryReasoningEngineOperationsClient

public virtual OperationsClient AsyncQueryReasoningEngineOperationsClient { get; }

The long-running operations client for AsyncQueryReasoningEngine.

Property Value
Type	Description
OperationsClient

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the ReasoningEngineExecutionService service, which is a host of "aiplatform.googleapis.com" and a port of 443.

Property Value
Type	Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default ReasoningEngineExecutionService scopes.

Property Value
Type	Description
IReadOnlyListstring

Remarks

The default ReasoningEngineExecutionService scopes are:

• https://www.googleapis.com/auth/cloud-platform

GrpcClient

public virtual ReasoningEngineExecutionService.ReasoningEngineExecutionServiceClient GrpcClient { get; }

The underlying gRPC ReasoningEngineExecutionService client

Property Value
Type	Description
ReasoningEngineExecutionServiceReasoningEngineExecutionServiceClient

IAMPolicyClient

public virtual IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

LocationsClient

public virtual LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type	Description
ServiceMetadata

Methods

AsyncQueryReasoningEngine(AsyncQueryReasoningEngineRequest, CallSettings)

public virtual Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> AsyncQueryReasoningEngine(AsyncQueryReasoningEngineRequest request, CallSettings callSettings = null)

Async query using a reasoning engine.

Parameters
Name	Description
request	AsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationAsyncQueryReasoningEngineResponseAsyncQueryReasoningEngineOperationMetadata	The RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = ReasoningEngineExecutionServiceClient.Create();
// Initialize request argument(s)
AsyncQueryReasoningEngineRequest request = new AsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    InputGcsUri = "",
    OutputGcsUri = "",
};
// Make the request
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> response = reasoningEngineExecutionServiceClient.AsyncQueryReasoningEngine(request);

// Poll until the returned long-running operation is complete
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> completedResponse = response.PollUntilCompleted();
// Retrieve the operation result
AsyncQueryReasoningEngineResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> retrievedResponse = reasoningEngineExecutionServiceClient.PollOnceAsyncQueryReasoningEngine(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AsyncQueryReasoningEngineResponse retrievedResult = retrievedResponse.Result;
}

AsyncQueryReasoningEngineAsync(AsyncQueryReasoningEngineRequest, CallSettings)

public virtual Task<Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata>> AsyncQueryReasoningEngineAsync(AsyncQueryReasoningEngineRequest request, CallSettings callSettings = null)

Async query using a reasoning engine.

Parameters
Name	Description
request	AsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationAsyncQueryReasoningEngineResponseAsyncQueryReasoningEngineOperationMetadata	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
AsyncQueryReasoningEngineRequest request = new AsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    InputGcsUri = "",
    OutputGcsUri = "",
};
// Make the request
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> response = await reasoningEngineExecutionServiceClient.AsyncQueryReasoningEngineAsync(request);

// Poll until the returned long-running operation is complete
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AsyncQueryReasoningEngineResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> retrievedResponse = await reasoningEngineExecutionServiceClient.PollOnceAsyncQueryReasoningEngineAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AsyncQueryReasoningEngineResponse retrievedResult = retrievedResponse.Result;
}

AsyncQueryReasoningEngineAsync(AsyncQueryReasoningEngineRequest, CancellationToken)

public virtual Task<Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata>> AsyncQueryReasoningEngineAsync(AsyncQueryReasoningEngineRequest request, CancellationToken cancellationToken)

Async query using a reasoning engine.

Parameters
Name	Description
request	AsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskOperationAsyncQueryReasoningEngineResponseAsyncQueryReasoningEngineOperationMetadata	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
AsyncQueryReasoningEngineRequest request = new AsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    InputGcsUri = "",
    OutputGcsUri = "",
};
// Make the request
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> response = await reasoningEngineExecutionServiceClient.AsyncQueryReasoningEngineAsync(request);

// Poll until the returned long-running operation is complete
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> completedResponse = await response.PollUntilCompletedAsync();
// Retrieve the operation result
AsyncQueryReasoningEngineResponse result = completedResponse.Result;

// Or get the name of the operation
string operationName = response.Name;
// This name can be stored, then the long-running operation retrieved later by name
Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> retrievedResponse = await reasoningEngineExecutionServiceClient.PollOnceAsyncQueryReasoningEngineAsync(operationName);
// Check if the retrieved long-running operation has completed
if (retrievedResponse.IsCompleted)
{
    // If it has completed, then access the result
    AsyncQueryReasoningEngineResponse retrievedResult = retrievedResponse.Result;
}

CancelAsyncQueryReasoningEngine(CancelAsyncQueryReasoningEngineRequest, CallSettings)

public virtual CancelAsyncQueryReasoningEngineResponse CancelAsyncQueryReasoningEngine(CancelAsyncQueryReasoningEngineRequest request, CallSettings callSettings = null)

Cancels an AsyncQueryReasoningEngine operation.

Parameters
Name	Description
request	CancelAsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
CancelAsyncQueryReasoningEngineResponse	The RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = ReasoningEngineExecutionServiceClient.Create();
// Initialize request argument(s)
CancelAsyncQueryReasoningEngineRequest request = new CancelAsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    OperationName = "",
};
// Make the request
CancelAsyncQueryReasoningEngineResponse response = reasoningEngineExecutionServiceClient.CancelAsyncQueryReasoningEngine(request);

CancelAsyncQueryReasoningEngineAsync(CancelAsyncQueryReasoningEngineRequest, CallSettings)

public virtual Task<CancelAsyncQueryReasoningEngineResponse> CancelAsyncQueryReasoningEngineAsync(CancelAsyncQueryReasoningEngineRequest request, CallSettings callSettings = null)

Cancels an AsyncQueryReasoningEngine operation.

Parameters
Name	Description
request	CancelAsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskCancelAsyncQueryReasoningEngineResponse	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
CancelAsyncQueryReasoningEngineRequest request = new CancelAsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    OperationName = "",
};
// Make the request
CancelAsyncQueryReasoningEngineResponse response = await reasoningEngineExecutionServiceClient.CancelAsyncQueryReasoningEngineAsync(request);

CancelAsyncQueryReasoningEngineAsync(CancelAsyncQueryReasoningEngineRequest, CancellationToken)

public virtual Task<CancelAsyncQueryReasoningEngineResponse> CancelAsyncQueryReasoningEngineAsync(CancelAsyncQueryReasoningEngineRequest request, CancellationToken cancellationToken)

Cancels an AsyncQueryReasoningEngine operation.

Parameters
Name	Description
request	CancelAsyncQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskCancelAsyncQueryReasoningEngineResponse	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
CancelAsyncQueryReasoningEngineRequest request = new CancelAsyncQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    OperationName = "",
};
// Make the request
CancelAsyncQueryReasoningEngineResponse response = await reasoningEngineExecutionServiceClient.CancelAsyncQueryReasoningEngineAsync(request);

Create()

public static ReasoningEngineExecutionServiceClient Create()

Synchronously creates a ReasoningEngineExecutionServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReasoningEngineExecutionServiceClientBuilder.

Returns
Type	Description
ReasoningEngineExecutionServiceClient	The created ReasoningEngineExecutionServiceClient.

CreateAsync(CancellationToken)

public static Task<ReasoningEngineExecutionServiceClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a ReasoningEngineExecutionServiceClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use ReasoningEngineExecutionServiceClientBuilder.

Parameter
Name	Description
cancellationToken	CancellationToken The CancellationToken to use while creating the client.

Returns
Type	Description
TaskReasoningEngineExecutionServiceClient	The task representing the created ReasoningEngineExecutionServiceClient.

PollOnceAsyncQueryReasoningEngine(string, CallSettings)

public virtual Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata> PollOnceAsyncQueryReasoningEngine(string operationName, CallSettings callSettings = null)

Poll an operation once, using an operationName from a previous invocation of AsyncQueryReasoningEngine.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationAsyncQueryReasoningEngineResponseAsyncQueryReasoningEngineOperationMetadata	The result of polling the operation.

PollOnceAsyncQueryReasoningEngineAsync(string, CallSettings)

public virtual Task<Operation<AsyncQueryReasoningEngineResponse, AsyncQueryReasoningEngineOperationMetadata>> PollOnceAsyncQueryReasoningEngineAsync(string operationName, CallSettings callSettings = null)

Asynchronously poll an operation once, using an operationName from a previous invocation of AsyncQueryReasoningEngine.

Parameters
Name	Description
operationName	string The name of a previously invoked operation. Must not be null or empty.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationAsyncQueryReasoningEngineResponseAsyncQueryReasoningEngineOperationMetadata	A task representing the result of polling the operation.

QueryReasoningEngine(QueryReasoningEngineRequest, CallSettings)

public virtual QueryReasoningEngineResponse QueryReasoningEngine(QueryReasoningEngineRequest request, CallSettings callSettings = null)

Queries using a reasoning engine.

Parameters
Name	Description
request	QueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
QueryReasoningEngineResponse	The RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = ReasoningEngineExecutionServiceClient.Create();
// Initialize request argument(s)
QueryReasoningEngineRequest request = new QueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Input = new Struct(),
    ClassMethod = "",
};
// Make the request
QueryReasoningEngineResponse response = reasoningEngineExecutionServiceClient.QueryReasoningEngine(request);

QueryReasoningEngineAsync(QueryReasoningEngineRequest, CallSettings)

public virtual Task<QueryReasoningEngineResponse> QueryReasoningEngineAsync(QueryReasoningEngineRequest request, CallSettings callSettings = null)

Queries using a reasoning engine.

Parameters
Name	Description
request	QueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskQueryReasoningEngineResponse	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
QueryReasoningEngineRequest request = new QueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Input = new Struct(),
    ClassMethod = "",
};
// Make the request
QueryReasoningEngineResponse response = await reasoningEngineExecutionServiceClient.QueryReasoningEngineAsync(request);

QueryReasoningEngineAsync(QueryReasoningEngineRequest, CancellationToken)

public virtual Task<QueryReasoningEngineResponse> QueryReasoningEngineAsync(QueryReasoningEngineRequest request, CancellationToken cancellationToken)

Queries using a reasoning engine.

Parameters
Name	Description
request	QueryReasoningEngineRequest The request object containing all of the parameters for the API call.
cancellationToken	CancellationToken A CancellationToken to use for this RPC.

Returns
Type	Description
TaskQueryReasoningEngineResponse	A Task containing the RPC response.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = await ReasoningEngineExecutionServiceClient.CreateAsync();
// Initialize request argument(s)
QueryReasoningEngineRequest request = new QueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Input = new Struct(),
    ClassMethod = "",
};
// Make the request
QueryReasoningEngineResponse response = await reasoningEngineExecutionServiceClient.QueryReasoningEngineAsync(request);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type	Description
Task	A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

StreamQueryReasoningEngine(StreamQueryReasoningEngineRequest, CallSettings)

public virtual ReasoningEngineExecutionServiceClient.StreamQueryReasoningEngineStream StreamQueryReasoningEngine(StreamQueryReasoningEngineRequest request, CallSettings callSettings = null)

Streams queries using a reasoning engine.

Parameters
Name	Description
request	StreamQueryReasoningEngineRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
ReasoningEngineExecutionServiceClientStreamQueryReasoningEngineStream	The server stream.

Example

// Create client
ReasoningEngineExecutionServiceClient reasoningEngineExecutionServiceClient = ReasoningEngineExecutionServiceClient.Create();
// Initialize request argument(s)
StreamQueryReasoningEngineRequest request = new StreamQueryReasoningEngineRequest
{
    ReasoningEngineName = ReasoningEngineName.FromProjectLocationReasoningEngine("[PROJECT]", "[LOCATION]", "[REASONING_ENGINE]"),
    Input = new Struct(),
    ClassMethod = "",
};
// Make the request, returning a streaming response
using ReasoningEngineExecutionServiceClient.StreamQueryReasoningEngineStream response = reasoningEngineExecutionServiceClient.StreamQueryReasoningEngine(request);

// Read streaming responses from server until complete
// Note that C# 8 code can use await foreach
AsyncResponseStream<HttpBody> responseStream = response.GetResponseStream();
while (await responseStream.MoveNextAsync())
{
    HttpBody responseItem = responseStream.Current;
    // Do something with streamed response
}
// The response stream has completed