Discovery Engine v1 API - Class GroundedGenerationService.GroundedGenerationServiceClient (1.5.0)

Version 1.5.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public class GroundedGenerationService.GroundedGenerationServiceClient : ClientBase<GroundedGenerationService.GroundedGenerationServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class GroundedGenerationService.GroundedGenerationServiceClient.

Client for GroundedGenerationService

Inheritance

object > ClientBase > ClientBaseGroundedGenerationServiceGroundedGenerationServiceClient > GroundedGenerationService.GroundedGenerationServiceClient

Inherited Members

ClientBase<GroundedGenerationService.GroundedGenerationServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

GroundedGenerationServiceClient()

protected GroundedGenerationServiceClient()

Protected parameterless constructor to allow creation of test doubles.

GroundedGenerationServiceClient(CallInvoker)

public GroundedGenerationServiceClient(CallInvoker callInvoker)

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

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

GroundedGenerationServiceClient(ChannelBase)

public GroundedGenerationServiceClient(ChannelBase channel)

Creates a new client for GroundedGenerationService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

GroundedGenerationServiceClient(ClientBaseConfiguration)

protected GroundedGenerationServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CheckGrounding(CheckGroundingRequest, CallOptions)

public virtual CheckGroundingResponse CheckGrounding(CheckGroundingRequest request, CallOptions options)

Performs a grounding check.

Parameters
Name	Description
request	CheckGroundingRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
CheckGroundingResponse	The response received from the server.

CheckGrounding(CheckGroundingRequest, Metadata, DateTime?, CancellationToken)

public virtual CheckGroundingResponse CheckGrounding(CheckGroundingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Performs a grounding check.

Parameters
Name	Description
request	CheckGroundingRequest 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
CheckGroundingResponse	The response received from the server.

CheckGroundingAsync(CheckGroundingRequest, CallOptions)

public virtual AsyncUnaryCall<CheckGroundingResponse> CheckGroundingAsync(CheckGroundingRequest request, CallOptions options)

Performs a grounding check.

Parameters
Name	Description
request	CheckGroundingRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallCheckGroundingResponse	The call object.

CheckGroundingAsync(CheckGroundingRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<CheckGroundingResponse> CheckGroundingAsync(CheckGroundingRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Performs a grounding check.

Parameters
Name	Description
request	CheckGroundingRequest 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
AsyncUnaryCallCheckGroundingResponse	The call object.

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.

GenerateGroundedContent(GenerateGroundedContentRequest, CallOptions)

public virtual GenerateGroundedContentResponse GenerateGroundedContent(GenerateGroundedContentRequest request, CallOptions options)

Generates grounded content.

Parameters
Name	Description
request	GenerateGroundedContentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
GenerateGroundedContentResponse	The response received from the server.

GenerateGroundedContent(GenerateGroundedContentRequest, Metadata, DateTime?, CancellationToken)

public virtual GenerateGroundedContentResponse GenerateGroundedContent(GenerateGroundedContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates grounded content.

Parameters
Name	Description
request	GenerateGroundedContentRequest 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
GenerateGroundedContentResponse	The response received from the server.

GenerateGroundedContentAsync(GenerateGroundedContentRequest, CallOptions)

public virtual AsyncUnaryCall<GenerateGroundedContentResponse> GenerateGroundedContentAsync(GenerateGroundedContentRequest request, CallOptions options)

Generates grounded content.

Parameters
Name	Description
request	GenerateGroundedContentRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallGenerateGroundedContentResponse	The call object.

GenerateGroundedContentAsync(GenerateGroundedContentRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<GenerateGroundedContentResponse> GenerateGroundedContentAsync(GenerateGroundedContentRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates grounded content.

Parameters
Name	Description
request	GenerateGroundedContentRequest 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
AsyncUnaryCallGenerateGroundedContentResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override GroundedGenerationService.GroundedGenerationServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
GroundedGenerationServiceGroundedGenerationServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.DiscoveryEngine.V1.GroundedGenerationService.GroundedGenerationServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StreamGenerateGroundedContent(CallOptions)

public virtual AsyncDuplexStreamingCall<GenerateGroundedContentRequest, GenerateGroundedContentResponse> StreamGenerateGroundedContent(CallOptions options)

Generates grounded content in a streaming fashion.

Parameter
Name	Description
options	CallOptions The options for the call.

Returns
Type	Description
AsyncDuplexStreamingCallGenerateGroundedContentRequestGenerateGroundedContentResponse	The call object.

StreamGenerateGroundedContent(Metadata, DateTime?, CancellationToken)

public virtual AsyncDuplexStreamingCall<GenerateGroundedContentRequest, GenerateGroundedContentResponse> StreamGenerateGroundedContent(Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Generates grounded content in a streaming fashion.

Parameters
Name	Description
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
AsyncDuplexStreamingCallGenerateGroundedContentRequestGenerateGroundedContentResponse	The call object.