Cloud AI Platform v1 API - Class VertexRagService.VertexRagServiceClient (3.12.0)

Version 3.12.0

• 3.13.0 (latest)
• 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 class VertexRagService.VertexRagServiceClient : ClientBase<VertexRagService.VertexRagServiceClient>

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

Client for VertexRagService

Inheritance

object > ClientBase > ClientBaseVertexRagServiceVertexRagServiceClient > VertexRagService.VertexRagServiceClient

Inherited Members

ClientBase<VertexRagService.VertexRagServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

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

AugmentPrompt(AugmentPromptRequest, CallOptions)

public virtual AugmentPromptResponse AugmentPrompt(AugmentPromptRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AugmentPromptResponse	The response received from the server.

AugmentPrompt(AugmentPromptRequest, Metadata, DateTime?, CancellationToken)

public virtual AugmentPromptResponse AugmentPrompt(AugmentPromptRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AugmentPromptResponse	The response received from the server.

AugmentPromptAsync(AugmentPromptRequest, CallOptions)

public virtual AsyncUnaryCall<AugmentPromptResponse> AugmentPromptAsync(AugmentPromptRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallAugmentPromptResponse	The call object.

AugmentPromptAsync(AugmentPromptRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<AugmentPromptResponse> AugmentPromptAsync(AugmentPromptRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AsyncUnaryCallAugmentPromptResponse	The call object.

CorroborateContent(CorroborateContentRequest, CallOptions)

public virtual CorroborateContentResponse CorroborateContent(CorroborateContentRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CorroborateContentResponse	The response received from the server.

CorroborateContent(CorroborateContentRequest, Metadata, DateTime?, CancellationToken)

public virtual CorroborateContentResponse CorroborateContent(CorroborateContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
CorroborateContentResponse	The response received from the server.

CorroborateContentAsync(CorroborateContentRequest, CallOptions)

public virtual AsyncUnaryCall<CorroborateContentResponse> CorroborateContentAsync(CorroborateContentRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCorroborateContentResponse	The call object.

CorroborateContentAsync(CorroborateContentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CorroborateContentResponse> CorroborateContentAsync(CorroborateContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 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
AsyncUnaryCallCorroborateContentResponse	The call object.

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.V1.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.