| GitHub Repository | Product Reference |
Service Description: Service for grounded generation.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create()) {
CheckGroundingRequest request =
CheckGroundingRequest.newBuilder()
.setGroundingConfig(
GroundingConfigName.of("[PROJECT]", "[LOCATION]", "[GROUNDING_CONFIG]")
.toString())
.setAnswerCandidate("answerCandidate-292402331")
.addAllFacts(new ArrayList<GroundingFact>())
.setGroundingSpec(CheckGroundingSpec.newBuilder().build())
.build();
CheckGroundingResponse response = groundedGenerationServiceClient.checkGrounding(request);
}
Note: close() needs to be called on the GroundedGenerationServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
| Method | Description | Method Variants |
|---|---|---|
CheckGrounding |
Performs a grounding check. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of GroundedGenerationServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
GroundedGenerationServiceSettings groundedGenerationServiceSettings =
GroundedGenerationServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create(groundedGenerationServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
GroundedGenerationServiceSettings groundedGenerationServiceSettings =
GroundedGenerationServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create(groundedGenerationServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
GroundedGenerationServiceSettings groundedGenerationServiceSettings =
GroundedGenerationServiceSettings.newHttpJsonBuilder().build();
GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create(groundedGenerationServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final GroundedGenerationServiceClient create()Constructs an instance of GroundedGenerationServiceClient with default settings.
| Returns | |
|---|---|
| Type | Description |
GroundedGenerationServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(GroundedGenerationServiceSettings settings)
public static final GroundedGenerationServiceClient create(GroundedGenerationServiceSettings settings)Constructs an instance of GroundedGenerationServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
| Parameter | |
|---|---|
| Name | Description |
settings |
GroundedGenerationServiceSettings |
| Returns | |
|---|---|
| Type | Description |
GroundedGenerationServiceClient |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
create(GroundedGenerationServiceStub stub)
public static final GroundedGenerationServiceClient create(GroundedGenerationServiceStub stub)Constructs an instance of GroundedGenerationServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(GroundedGenerationServiceSettings).
| Parameter | |
|---|---|
| Name | Description |
stub |
GroundedGenerationServiceStub |
| Returns | |
|---|---|
| Type | Description |
GroundedGenerationServiceClient |
|
Constructors
GroundedGenerationServiceClient(GroundedGenerationServiceSettings settings)
protected GroundedGenerationServiceClient(GroundedGenerationServiceSettings settings)Constructs an instance of GroundedGenerationServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
| Parameter | |
|---|---|
| Name | Description |
settings |
GroundedGenerationServiceSettings |
GroundedGenerationServiceClient(GroundedGenerationServiceStub stub)
protected GroundedGenerationServiceClient(GroundedGenerationServiceStub stub)| Parameter | |
|---|---|
| Name | Description |
stub |
GroundedGenerationServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)| Parameters | |
|---|---|
| Name | Description |
duration |
long |
unit |
TimeUnit |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
| Exceptions | |
|---|---|
| Type | Description |
InterruptedException |
|
checkGrounding(CheckGroundingRequest request)
public final CheckGroundingResponse checkGrounding(CheckGroundingRequest request)Performs a grounding check.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create()) {
CheckGroundingRequest request =
CheckGroundingRequest.newBuilder()
.setGroundingConfig(
GroundingConfigName.of("[PROJECT]", "[LOCATION]", "[GROUNDING_CONFIG]")
.toString())
.setAnswerCandidate("answerCandidate-292402331")
.addAllFacts(new ArrayList<GroundingFact>())
.setGroundingSpec(CheckGroundingSpec.newBuilder().build())
.build();
CheckGroundingResponse response = groundedGenerationServiceClient.checkGrounding(request);
}
| Parameter | |
|---|---|
| Name | Description |
request |
CheckGroundingRequestThe request object containing all of the parameters for the API call. |
| Returns | |
|---|---|
| Type | Description |
CheckGroundingResponse |
|
checkGroundingCallable()
public final UnaryCallable<CheckGroundingRequest,CheckGroundingResponse> checkGroundingCallable()Performs a grounding check.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (GroundedGenerationServiceClient groundedGenerationServiceClient =
GroundedGenerationServiceClient.create()) {
CheckGroundingRequest request =
CheckGroundingRequest.newBuilder()
.setGroundingConfig(
GroundingConfigName.of("[PROJECT]", "[LOCATION]", "[GROUNDING_CONFIG]")
.toString())
.setAnswerCandidate("answerCandidate-292402331")
.addAllFacts(new ArrayList<GroundingFact>())
.setGroundingSpec(CheckGroundingSpec.newBuilder().build())
.build();
ApiFuture<CheckGroundingResponse> future =
groundedGenerationServiceClient.checkGroundingCallable().futureCall(request);
// Do something.
CheckGroundingResponse response = future.get();
}
| Returns | |
|---|---|
| Type | Description |
UnaryCallable<CheckGroundingRequest,CheckGroundingResponse> |
|
close()
public final void close()getSettings()
public final GroundedGenerationServiceSettings getSettings()| Returns | |
|---|---|
| Type | Description |
GroundedGenerationServiceSettings |
|
getStub()
public GroundedGenerationServiceStub getStub()| Returns | |
|---|---|
| Type | Description |
GroundedGenerationServiceStub |
|
isShutdown()
public boolean isShutdown()| Returns | |
|---|---|
| Type | Description |
boolean |
|
isTerminated()
public boolean isTerminated()| Returns | |
|---|---|
| Type | Description |
boolean |
|
shutdown()
public void shutdown()shutdownNow()
public void shutdownNow()