Cloud AI Platform v1 API - Class VertexRagDataService.VertexRagDataServiceClient (3.13.0)

public class VertexRagDataService.VertexRagDataServiceClient : ClientBase<VertexRagDataService.VertexRagDataServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class VertexRagDataService.VertexRagDataServiceClient.

Client for VertexRagDataService

Inheritance

object > ClientBase > ClientBaseVertexRagDataServiceVertexRagDataServiceClient > VertexRagDataService.VertexRagDataServiceClient

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

VertexRagDataServiceClient()

protected VertexRagDataServiceClient()

Protected parameterless constructor to allow creation of test doubles.

VertexRagDataServiceClient(CallInvoker)

public VertexRagDataServiceClient(CallInvoker callInvoker)

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

Parameter
Name Description
callInvoker CallInvoker

The callInvoker to use to make remote calls.

VertexRagDataServiceClient(ChannelBase)

public VertexRagDataServiceClient(ChannelBase channel)

Creates a new client for VertexRagDataService

Parameter
Name Description
channel ChannelBase

The channel to use to make remote calls.

VertexRagDataServiceClient(ClientBaseConfiguration)

protected VertexRagDataServiceClient(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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type Description
OperationsOperationsClient

A new Operations client for the same target as this client.

CreateRagCorpus(CreateRagCorpusRequest, CallOptions)

public virtual Operation CreateRagCorpus(CreateRagCorpusRequest request, CallOptions options)

Creates a RagCorpus.

Parameters
Name Description
request CreateRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

CreateRagCorpus(CreateRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateRagCorpus(CreateRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a RagCorpus.

Parameters
Name Description
request CreateRagCorpusRequest

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
Operation

The response received from the server.

CreateRagCorpusAsync(CreateRagCorpusRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateRagCorpusAsync(CreateRagCorpusRequest request, CallOptions options)

Creates a RagCorpus.

Parameters
Name Description
request CreateRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

CreateRagCorpusAsync(CreateRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateRagCorpusAsync(CreateRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a RagCorpus.

Parameters
Name Description
request CreateRagCorpusRequest

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
AsyncUnaryCallOperation

The call object.

DeleteRagCorpus(DeleteRagCorpusRequest, CallOptions)

public virtual Operation DeleteRagCorpus(DeleteRagCorpusRequest request, CallOptions options)

Deletes a RagCorpus.

Parameters
Name Description
request DeleteRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteRagCorpus(DeleteRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRagCorpus(DeleteRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a RagCorpus.

Parameters
Name Description
request DeleteRagCorpusRequest

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
Operation

The response received from the server.

DeleteRagCorpusAsync(DeleteRagCorpusRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRagCorpusAsync(DeleteRagCorpusRequest request, CallOptions options)

Deletes a RagCorpus.

Parameters
Name Description
request DeleteRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRagCorpusAsync(DeleteRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRagCorpusAsync(DeleteRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a RagCorpus.

Parameters
Name Description
request DeleteRagCorpusRequest

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
AsyncUnaryCallOperation

The call object.

DeleteRagFile(DeleteRagFileRequest, CallOptions)

public virtual Operation DeleteRagFile(DeleteRagFileRequest request, CallOptions options)

Deletes a RagFile.

Parameters
Name Description
request DeleteRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

DeleteRagFile(DeleteRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteRagFile(DeleteRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a RagFile.

Parameters
Name Description
request DeleteRagFileRequest

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
Operation

The response received from the server.

DeleteRagFileAsync(DeleteRagFileRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteRagFileAsync(DeleteRagFileRequest request, CallOptions options)

Deletes a RagFile.

Parameters
Name Description
request DeleteRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

DeleteRagFileAsync(DeleteRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteRagFileAsync(DeleteRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a RagFile.

Parameters
Name Description
request DeleteRagFileRequest

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
AsyncUnaryCallOperation

The call object.

GetRagCorpus(GetRagCorpusRequest, CallOptions)

public virtual RagCorpus GetRagCorpus(GetRagCorpusRequest request, CallOptions options)

Gets a RagCorpus.

Parameters
Name Description
request GetRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RagCorpus

The response received from the server.

GetRagCorpus(GetRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual RagCorpus GetRagCorpus(GetRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a RagCorpus.

Parameters
Name Description
request GetRagCorpusRequest

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
RagCorpus

The response received from the server.

GetRagCorpusAsync(GetRagCorpusRequest, CallOptions)

public virtual AsyncUnaryCall<RagCorpus> GetRagCorpusAsync(GetRagCorpusRequest request, CallOptions options)

Gets a RagCorpus.

Parameters
Name Description
request GetRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRagCorpus

The call object.

GetRagCorpusAsync(GetRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RagCorpus> GetRagCorpusAsync(GetRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a RagCorpus.

Parameters
Name Description
request GetRagCorpusRequest

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
AsyncUnaryCallRagCorpus

The call object.

GetRagFile(GetRagFileRequest, CallOptions)

public virtual RagFile GetRagFile(GetRagFileRequest request, CallOptions options)

Gets a RagFile.

Parameters
Name Description
request GetRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
RagFile

The response received from the server.

GetRagFile(GetRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual RagFile GetRagFile(GetRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a RagFile.

Parameters
Name Description
request GetRagFileRequest

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
RagFile

The response received from the server.

GetRagFileAsync(GetRagFileRequest, CallOptions)

public virtual AsyncUnaryCall<RagFile> GetRagFileAsync(GetRagFileRequest request, CallOptions options)

Gets a RagFile.

Parameters
Name Description
request GetRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallRagFile

The call object.

GetRagFileAsync(GetRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<RagFile> GetRagFileAsync(GetRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a RagFile.

Parameters
Name Description
request GetRagFileRequest

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
AsyncUnaryCallRagFile

The call object.

ImportRagFiles(ImportRagFilesRequest, CallOptions)

public virtual Operation ImportRagFiles(ImportRagFilesRequest request, CallOptions options)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Parameters
Name Description
request ImportRagFilesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

ImportRagFiles(ImportRagFilesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportRagFiles(ImportRagFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Parameters
Name Description
request ImportRagFilesRequest

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
Operation

The response received from the server.

ImportRagFilesAsync(ImportRagFilesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportRagFilesAsync(ImportRagFilesRequest request, CallOptions options)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Parameters
Name Description
request ImportRagFilesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

ImportRagFilesAsync(ImportRagFilesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportRagFilesAsync(ImportRagFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Import files from Google Cloud Storage or Google Drive into a RagCorpus.

Parameters
Name Description
request ImportRagFilesRequest

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
AsyncUnaryCallOperation

The call object.

ListRagCorpora(ListRagCorporaRequest, CallOptions)

public virtual ListRagCorporaResponse ListRagCorpora(ListRagCorporaRequest request, CallOptions options)

Lists RagCorpora in a Location.

Parameters
Name Description
request ListRagCorporaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRagCorporaResponse

The response received from the server.

ListRagCorpora(ListRagCorporaRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRagCorporaResponse ListRagCorpora(ListRagCorporaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists RagCorpora in a Location.

Parameters
Name Description
request ListRagCorporaRequest

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
ListRagCorporaResponse

The response received from the server.

ListRagCorporaAsync(ListRagCorporaRequest, CallOptions)

public virtual AsyncUnaryCall<ListRagCorporaResponse> ListRagCorporaAsync(ListRagCorporaRequest request, CallOptions options)

Lists RagCorpora in a Location.

Parameters
Name Description
request ListRagCorporaRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRagCorporaResponse

The call object.

ListRagCorporaAsync(ListRagCorporaRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRagCorporaResponse> ListRagCorporaAsync(ListRagCorporaRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists RagCorpora in a Location.

Parameters
Name Description
request ListRagCorporaRequest

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
AsyncUnaryCallListRagCorporaResponse

The call object.

ListRagFiles(ListRagFilesRequest, CallOptions)

public virtual ListRagFilesResponse ListRagFiles(ListRagFilesRequest request, CallOptions options)

Lists RagFiles in a RagCorpus.

Parameters
Name Description
request ListRagFilesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
ListRagFilesResponse

The response received from the server.

ListRagFiles(ListRagFilesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListRagFilesResponse ListRagFiles(ListRagFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists RagFiles in a RagCorpus.

Parameters
Name Description
request ListRagFilesRequest

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
ListRagFilesResponse

The response received from the server.

ListRagFilesAsync(ListRagFilesRequest, CallOptions)

public virtual AsyncUnaryCall<ListRagFilesResponse> ListRagFilesAsync(ListRagFilesRequest request, CallOptions options)

Lists RagFiles in a RagCorpus.

Parameters
Name Description
request ListRagFilesRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallListRagFilesResponse

The call object.

ListRagFilesAsync(ListRagFilesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListRagFilesResponse> ListRagFilesAsync(ListRagFilesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists RagFiles in a RagCorpus.

Parameters
Name Description
request ListRagFilesRequest

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
AsyncUnaryCallListRagFilesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override VertexRagDataService.VertexRagDataServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name Description
configuration ClientBaseClientBaseConfiguration
Returns
Type Description
VertexRagDataServiceVertexRagDataServiceClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.AIPlatform.V1.VertexRagDataService.VertexRagDataServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

UpdateRagCorpus(UpdateRagCorpusRequest, CallOptions)

public virtual Operation UpdateRagCorpus(UpdateRagCorpusRequest request, CallOptions options)

Updates a RagCorpus.

Parameters
Name Description
request UpdateRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
Operation

The response received from the server.

UpdateRagCorpus(UpdateRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateRagCorpus(UpdateRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a RagCorpus.

Parameters
Name Description
request UpdateRagCorpusRequest

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
Operation

The response received from the server.

UpdateRagCorpusAsync(UpdateRagCorpusRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateRagCorpusAsync(UpdateRagCorpusRequest request, CallOptions options)

Updates a RagCorpus.

Parameters
Name Description
request UpdateRagCorpusRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallOperation

The call object.

UpdateRagCorpusAsync(UpdateRagCorpusRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateRagCorpusAsync(UpdateRagCorpusRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a RagCorpus.

Parameters
Name Description
request UpdateRagCorpusRequest

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
AsyncUnaryCallOperation

The call object.

UploadRagFile(UploadRagFileRequest, CallOptions)

public virtual UploadRagFileResponse UploadRagFile(UploadRagFileRequest request, CallOptions options)

Upload a file into a RagCorpus.

Parameters
Name Description
request UploadRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
UploadRagFileResponse

The response received from the server.

UploadRagFile(UploadRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual UploadRagFileResponse UploadRagFile(UploadRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upload a file into a RagCorpus.

Parameters
Name Description
request UploadRagFileRequest

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
UploadRagFileResponse

The response received from the server.

UploadRagFileAsync(UploadRagFileRequest, CallOptions)

public virtual AsyncUnaryCall<UploadRagFileResponse> UploadRagFileAsync(UploadRagFileRequest request, CallOptions options)

Upload a file into a RagCorpus.

Parameters
Name Description
request UploadRagFileRequest

The request to send to the server.

options CallOptions

The options for the call.

Returns
Type Description
AsyncUnaryCallUploadRagFileResponse

The call object.

UploadRagFileAsync(UploadRagFileRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<UploadRagFileResponse> UploadRagFileAsync(UploadRagFileRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Upload a file into a RagCorpus.

Parameters
Name Description
request UploadRagFileRequest

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
AsyncUnaryCallUploadRagFileResponse

The call object.