Cloud AI Platform v1beta1 API - Class VertexRagService.VertexRagServiceClient (1.0.0-beta02)

public class VertexRagService.VertexRagServiceClient : ClientBase<VertexRagService.VertexRagServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1beta1 API class VertexRagService.VertexRagServiceClient.

Client for VertexRagService

Inheritance

object > ClientBase > ClientBaseVertexRagServiceVertexRagServiceClient > VertexRagService.VertexRagServiceClient

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

VertexRagServiceClient()

protected VertexRagServiceClient()

Protected parameterless constructor to allow creation of test doubles.

VertexRagServiceClient(CallInvoker)

public VertexRagServiceClient(CallInvoker callInvoker)

Creates a new client for VertexRagService that uses a custom CallInvoker.

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

VertexRagServiceClient(ChannelBase)

public VertexRagServiceClient(ChannelBase channel)

Creates a new client for VertexRagService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

VertexRagServiceClient(ClientBaseConfiguration)

protected VertexRagServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type Description
IAMPolicyIAMPolicyClient

A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type Description
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

NewInstance(ClientBaseConfiguration)

protected override VertexRagService.VertexRagServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
VertexRagServiceVertexRagServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1Beta1.VertexRagService.VertexRagServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RetrieveContexts(RetrieveContextsRequest, CallOptions)

public virtual RetrieveContextsResponse RetrieveContexts(RetrieveContextsRequest request, CallOptions options)

Retrieves relevant contexts for a query.

Parameters
Name Description
request RetrieveContextsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RetrieveContextsResponse

The response received from the server.

RetrieveContexts(RetrieveContextsRequest, Metadata, DateTime?, CancellationToken)

public virtual RetrieveContextsResponse RetrieveContexts(RetrieveContextsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves relevant contexts for a query.

Parameters
Name Description
request RetrieveContextsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
RetrieveContextsResponse

The response received from the server.

RetrieveContextsAsync(RetrieveContextsRequest, CallOptions)

public virtual AsyncUnaryCall<RetrieveContextsResponse> RetrieveContextsAsync(RetrieveContextsRequest request, CallOptions options)

Retrieves relevant contexts for a query.

Parameters
Name Description
request RetrieveContextsRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRetrieveContextsResponse

The call object.

RetrieveContextsAsync(RetrieveContextsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RetrieveContextsResponse> RetrieveContextsAsync(RetrieveContextsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieves relevant contexts for a query.

Parameters
Name Description
request RetrieveContextsRequest

The request to send to the server.

headers Metadata

The initial metadata to send with the call. This parameter is optional.

deadline System.DateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationToken CancellationToken

An optional token for canceling the call.

Returns
Type Description
AsyncUnaryCallRetrieveContextsResponse

The call object.