Cloud AI Platform v1beta1 API - Class VertexRagServiceClientImpl (1.0.0-beta11) 

public sealed class VertexRagServiceClientImpl : VertexRagServiceClient

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

VertexRagService client wrapper implementation, for convenient use.

Inheritance

object > VertexRagServiceClient > VertexRagServiceClientImpl

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.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

GrpcClient

public override VertexRagService.VertexRagServiceClient GrpcClient { get; }

The underlying gRPC VertexRagService client

Property Value
Type Description
VertexRagServiceVertexRagServiceClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

Methods

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

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

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

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

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

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