Vertex AI v1 API - Class VertexRagServiceClientImpl (3.67.0)

3.67.0 (latest) 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 sealed class VertexRagServiceClientImpl : VertexRagServiceClient

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

VertexRagService client wrapper implementation, for convenient use.

Inheritance

object > VertexRagServiceClient > VertexRagServiceClientImpl

Inherited Members

VertexRagServiceClient.DefaultEndpoint

VertexRagServiceClient.DefaultScopes

VertexRagServiceClient.ServiceMetadata

VertexRagServiceClient.CreateAsync(CancellationToken)

VertexRagServiceClient.Create()

VertexRagServiceClient.ShutdownDefaultChannelsAsync()

VertexRagServiceClient.RetrieveContextsAsync(RetrieveContextsRequest, CancellationToken)

VertexRagServiceClient.RetrieveContexts(string, RagQuery, CallSettings)

VertexRagServiceClient.RetrieveContextsAsync(string, RagQuery, CallSettings)

VertexRagServiceClient.RetrieveContextsAsync(string, RagQuery, CancellationToken)

VertexRagServiceClient.RetrieveContexts(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.RetrieveContextsAsync(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.RetrieveContextsAsync(LocationName, RagQuery, CancellationToken)

VertexRagServiceClient.AugmentPromptAsync(AugmentPromptRequest, CancellationToken)

VertexRagServiceClient.AugmentPrompt(string, AugmentPromptRequest.Types.Model, VertexRagStore, CallSettings)

VertexRagServiceClient.AugmentPromptAsync(string, AugmentPromptRequest.Types.Model, VertexRagStore, CallSettings)

VertexRagServiceClient.AugmentPromptAsync(string, AugmentPromptRequest.Types.Model, VertexRagStore, CancellationToken)

VertexRagServiceClient.AugmentPrompt(LocationName, AugmentPromptRequest.Types.Model, VertexRagStore, CallSettings)

VertexRagServiceClient.AugmentPromptAsync(LocationName, AugmentPromptRequest.Types.Model, VertexRagStore, CallSettings)

VertexRagServiceClient.AugmentPromptAsync(LocationName, AugmentPromptRequest.Types.Model, VertexRagStore, CancellationToken)

VertexRagServiceClient.CorroborateContentAsync(CorroborateContentRequest, CancellationToken)

VertexRagServiceClient.CorroborateContent(string, Content, IEnumerable<Fact>, CallSettings)

VertexRagServiceClient.CorroborateContentAsync(string, Content, IEnumerable<Fact>, CallSettings)

VertexRagServiceClient.CorroborateContentAsync(string, Content, IEnumerable<Fact>, CancellationToken)

VertexRagServiceClient.CorroborateContent(LocationName, Content, IEnumerable<Fact>, CallSettings)

VertexRagServiceClient.CorroborateContentAsync(LocationName, Content, IEnumerable<Fact>, CallSettings)

VertexRagServiceClient.CorroborateContentAsync(LocationName, Content, IEnumerable<Fact>, CancellationToken)

VertexRagServiceClient.AskContextsAsync(AskContextsRequest, CancellationToken)

VertexRagServiceClient.AskContexts(string, RagQuery, CallSettings)

VertexRagServiceClient.AskContextsAsync(string, RagQuery, CallSettings)

VertexRagServiceClient.AskContextsAsync(string, RagQuery, CancellationToken)

VertexRagServiceClient.AskContexts(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.AskContextsAsync(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.AskContextsAsync(LocationName, RagQuery, CancellationToken)

VertexRagServiceClient.AsyncRetrieveContextsAsync(AsyncRetrieveContextsRequest, CancellationToken)

VertexRagServiceClient.PollOnceAsyncRetrieveContexts(string, CallSettings)

VertexRagServiceClient.PollOnceAsyncRetrieveContextsAsync(string, CallSettings)

VertexRagServiceClient.AsyncRetrieveContexts(string, RagQuery, CallSettings)

VertexRagServiceClient.AsyncRetrieveContextsAsync(string, RagQuery, CallSettings)

VertexRagServiceClient.AsyncRetrieveContextsAsync(string, RagQuery, CancellationToken)

VertexRagServiceClient.AsyncRetrieveContexts(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.AsyncRetrieveContextsAsync(LocationName, RagQuery, CallSettings)

VertexRagServiceClient.AsyncRetrieveContextsAsync(LocationName, RagQuery, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Remarks

A service for retrieving relevant contexts.

Constructors

VertexRagServiceClientImpl(VertexRagServiceClient, VertexRagServiceSettings, ILogger)

public VertexRagServiceClientImpl(VertexRagService.VertexRagServiceClient grpcClient, VertexRagServiceSettings settings, ILogger logger)

Constructs a client wrapper for the VertexRagService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	VertexRagServiceVertexRagServiceClient The underlying gRPC client.
settings	VertexRagServiceSettings The base VertexRagServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

AsyncRetrieveContextsOperationsClient

public override OperationsClient AsyncRetrieveContextsOperationsClient { get; }

The long-running operations client for AsyncRetrieveContexts.

Property Value
Type	Description
OperationsClient

Overrides

VertexRagServiceClient.AsyncRetrieveContextsOperationsClient

GrpcClient

public override VertexRagService.VertexRagServiceClient GrpcClient { get; }

The underlying gRPC VertexRagService client

Property Value
Type	Description
VertexRagServiceVertexRagServiceClient

Overrides

VertexRagServiceClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

VertexRagServiceClient.IAMPolicyClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

VertexRagServiceClient.LocationsClient

Methods

AskContexts(AskContextsRequest, CallSettings)

public override AskContextsResponse AskContexts(AskContextsRequest request, CallSettings callSettings = null)

Agentic Retrieval Ask API for RAG.

Parameters
Name	Description
request	AskContextsRequest 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
AskContextsResponse	The RPC response.

Overrides

VertexRagServiceClient.AskContexts(AskContextsRequest, CallSettings)

AskContextsAsync(AskContextsRequest, CallSettings)

public override Task<AskContextsResponse> AskContextsAsync(AskContextsRequest request, CallSettings callSettings = null)

Agentic Retrieval Ask API for RAG.

Parameters
Name	Description
request	AskContextsRequest 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
TaskAskContextsResponse	A Task containing the RPC response.

Overrides

VertexRagServiceClient.AskContextsAsync(AskContextsRequest, CallSettings)

AsyncRetrieveContexts(AsyncRetrieveContextsRequest, CallSettings)

public override Operation<AsyncRetrieveContextsResponse, AsyncRetrieveContextsOperationMetadata> AsyncRetrieveContexts(AsyncRetrieveContextsRequest request, CallSettings callSettings = null)

Asynchronous API to retrieves relevant contexts for a query.

Parameters
Name	Description
request	AsyncRetrieveContextsRequest 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
OperationAsyncRetrieveContextsResponseAsyncRetrieveContextsOperationMetadata	The RPC response.

Overrides

VertexRagServiceClient.AsyncRetrieveContexts(AsyncRetrieveContextsRequest, CallSettings)

AsyncRetrieveContextsAsync(AsyncRetrieveContextsRequest, CallSettings)

public override Task<Operation<AsyncRetrieveContextsResponse, AsyncRetrieveContextsOperationMetadata>> AsyncRetrieveContextsAsync(AsyncRetrieveContextsRequest request, CallSettings callSettings = null)

Asynchronous API to retrieves relevant contexts for a query.

Parameters
Name	Description
request	AsyncRetrieveContextsRequest 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
TaskOperationAsyncRetrieveContextsResponseAsyncRetrieveContextsOperationMetadata	A Task containing the RPC response.

Overrides

VertexRagServiceClient.AsyncRetrieveContextsAsync(AsyncRetrieveContextsRequest, CallSettings)

AugmentPrompt(AugmentPromptRequest, CallSettings)

public override AugmentPromptResponse AugmentPrompt(AugmentPromptRequest request, CallSettings callSettings = null)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

Parameters
Name	Description
request	AugmentPromptRequest 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
AugmentPromptResponse	The RPC response.

Overrides

VertexRagServiceClient.AugmentPrompt(AugmentPromptRequest, CallSettings)

AugmentPromptAsync(AugmentPromptRequest, CallSettings)

public override Task<AugmentPromptResponse> AugmentPromptAsync(AugmentPromptRequest request, CallSettings callSettings = null)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

Parameters
Name	Description
request	AugmentPromptRequest 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
TaskAugmentPromptResponse	A Task containing the RPC response.

Overrides

VertexRagServiceClient.AugmentPromptAsync(AugmentPromptRequest, CallSettings)

CorroborateContent(CorroborateContentRequest, CallSettings)

public override CorroborateContentResponse CorroborateContent(CorroborateContentRequest request, CallSettings callSettings = null)

Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.

Parameters
Name	Description
request	CorroborateContentRequest 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
CorroborateContentResponse	The RPC response.

Overrides

VertexRagServiceClient.CorroborateContent(CorroborateContentRequest, CallSettings)

CorroborateContentAsync(CorroborateContentRequest, CallSettings)

public override Task<CorroborateContentResponse> CorroborateContentAsync(CorroborateContentRequest request, CallSettings callSettings = null)

Given an input text, it returns a score that evaluates the factuality of the text. It also extracts and returns claims from the text and provides supporting facts.

Parameters
Name	Description
request	CorroborateContentRequest 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
TaskCorroborateContentResponse	A Task containing the RPC response.

Overrides

VertexRagServiceClient.CorroborateContentAsync(CorroborateContentRequest, CallSettings)

RetrieveContexts(RetrieveContextsRequest, CallSettings)

public override RetrieveContextsResponse RetrieveContexts(RetrieveContextsRequest request, CallSettings callSettings = null)

Retrieves relevant contexts for a query.

Parameters
Name	Description
request	RetrieveContextsRequest 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
RetrieveContextsResponse	The RPC response.

Overrides

VertexRagServiceClient.RetrieveContexts(RetrieveContextsRequest, CallSettings)

RetrieveContextsAsync(RetrieveContextsRequest, CallSettings)

public override Task<RetrieveContextsResponse> RetrieveContextsAsync(RetrieveContextsRequest request, CallSettings callSettings = null)

Retrieves relevant contexts for a query.

Parameters
Name	Description
request	RetrieveContextsRequest 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
TaskRetrieveContextsResponse	A Task containing the RPC response.

Overrides

VertexRagServiceClient.RetrieveContextsAsync(RetrieveContextsRequest, CallSettings)