com.google.cloud.discoveryengine.v1

Class GroundedGenerationServiceClient

java.lang.Object

com.google.cloud.discoveryengine.v1.GroundedGenerationServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class GroundedGenerationServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

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()) {
   GenerateGroundedContentRequest request =
       GenerateGroundedContentRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSystemInstruction(GroundedGenerationContent.newBuilder().build())
           .addAllContents(new ArrayList<GroundedGenerationContent>())
           .setGenerationSpec(GenerateGroundedContentRequest.GenerationSpec.newBuilder().build())
           .setGroundingSpec(GenerateGroundedContentRequest.GroundingSpec.newBuilder().build())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   GenerateGroundedContentResponse response =
       groundedGenerationServiceClient.generateGroundedContent(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().

Methods

Method	Description	Method Variants
StreamGenerateGroundedContent	Generates grounded content in a streaming fashion.	Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. streamGenerateGroundedContentCallable()
GenerateGroundedContent	Generates grounded content.	Request object method variants only take one parameter, a request object, which must be constructed before the call. generateGroundedContent(GenerateGroundedContentRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. generateGroundedContentCallable()
CheckGrounding	Performs a grounding check.	Request object method variants only take one parameter, a request object, which must be constructed before the call. checkGrounding(CheckGroundingRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. checkGroundingCallable()

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.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GroundedGenerationServiceClient(GroundedGenerationServiceSettings settings) Constructs an instance of GroundedGenerationServiceClient, using the given settings.
protected	GroundedGenerationServiceClient(GroundedGenerationServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
CheckGroundingResponse	checkGrounding(CheckGroundingRequest request) Performs a grounding check.
com.google.api.gax.rpc.UnaryCallable<CheckGroundingRequest,CheckGroundingResponse>	checkGroundingCallable() Performs a grounding check.
void	close()
static GroundedGenerationServiceClient	create() Constructs an instance of GroundedGenerationServiceClient with default settings.
static GroundedGenerationServiceClient	create(GroundedGenerationServiceSettings settings) Constructs an instance of GroundedGenerationServiceClient, using the given settings.
static GroundedGenerationServiceClient	create(GroundedGenerationServiceStub stub) Constructs an instance of GroundedGenerationServiceClient, using the given stub for making calls.
GenerateGroundedContentResponse	generateGroundedContent(GenerateGroundedContentRequest request) Generates grounded content.
com.google.api.gax.rpc.UnaryCallable<GenerateGroundedContentRequest,GenerateGroundedContentResponse>	generateGroundedContentCallable() Generates grounded content.
GroundedGenerationServiceSettings	getSettings()
GroundedGenerationServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
void	shutdown()
void	shutdownNow()
com.google.api.gax.rpc.BidiStreamingCallable<GenerateGroundedContentRequest,GenerateGroundedContentResponse>	streamGenerateGroundedContentCallable() Generates grounded content in a streaming fashion.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GroundedGenerationServiceClient

protected GroundedGenerationServiceClient(GroundedGenerationServiceSettings settings)
                                   throws IOException

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.

Throws:

IOException

GroundedGenerationServiceClient

protected GroundedGenerationServiceClient(GroundedGenerationServiceStub stub)

Method Detail

create

public static final GroundedGenerationServiceClient create()
                                                    throws IOException

Constructs an instance of GroundedGenerationServiceClient with default settings.

Throws:

IOException

create

public static final GroundedGenerationServiceClient create(GroundedGenerationServiceSettings settings)
                                                    throws IOException

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.

Throws:

IOException

create

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

getSettings

public final GroundedGenerationServiceSettings getSettings()

getStub

public GroundedGenerationServiceStub getStub()

streamGenerateGroundedContentCallable

public final com.google.api.gax.rpc.BidiStreamingCallable<GenerateGroundedContentRequest,GenerateGroundedContentResponse> streamGenerateGroundedContentCallable()

Generates grounded content in a streaming fashion.

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()) {
   BidiStream<GenerateGroundedContentRequest, GenerateGroundedContentResponse> bidiStream =
       groundedGenerationServiceClient.streamGenerateGroundedContentCallable().call();
   GenerateGroundedContentRequest request =
       GenerateGroundedContentRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSystemInstruction(GroundedGenerationContent.newBuilder().build())
           .addAllContents(new ArrayList<GroundedGenerationContent>())
           .setGenerationSpec(GenerateGroundedContentRequest.GenerationSpec.newBuilder().build())
           .setGroundingSpec(GenerateGroundedContentRequest.GroundingSpec.newBuilder().build())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   bidiStream.send(request);
   for (GenerateGroundedContentResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }
 

generateGroundedContent

public final GenerateGroundedContentResponse generateGroundedContent(GenerateGroundedContentRequest request)

Generates grounded content.

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()) {
   GenerateGroundedContentRequest request =
       GenerateGroundedContentRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSystemInstruction(GroundedGenerationContent.newBuilder().build())
           .addAllContents(new ArrayList<GroundedGenerationContent>())
           .setGenerationSpec(GenerateGroundedContentRequest.GenerationSpec.newBuilder().build())
           .setGroundingSpec(GenerateGroundedContentRequest.GroundingSpec.newBuilder().build())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   GenerateGroundedContentResponse response =
       groundedGenerationServiceClient.generateGroundedContent(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

generateGroundedContentCallable

public final com.google.api.gax.rpc.UnaryCallable<GenerateGroundedContentRequest,GenerateGroundedContentResponse> generateGroundedContentCallable()

Generates grounded content.

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()) {
   GenerateGroundedContentRequest request =
       GenerateGroundedContentRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setSystemInstruction(GroundedGenerationContent.newBuilder().build())
           .addAllContents(new ArrayList<GroundedGenerationContent>())
           .setGenerationSpec(GenerateGroundedContentRequest.GenerationSpec.newBuilder().build())
           .setGroundingSpec(GenerateGroundedContentRequest.GroundingSpec.newBuilder().build())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   ApiFuture<GenerateGroundedContentResponse> future =
       groundedGenerationServiceClient.generateGroundedContentCallable().futureCall(request);
   // Do something.
   GenerateGroundedContentResponse response = future.get();
 }
 

checkGrounding

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())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   CheckGroundingResponse response = groundedGenerationServiceClient.checkGrounding(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

checkGroundingCallable

public final com.google.api.gax.rpc.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())
           .putAllUserLabels(new HashMap<String, String>())
           .build();
   ApiFuture<CheckGroundingResponse> future =
       groundedGenerationServiceClient.checkGroundingCallable().futureCall(request);
   // Do something.
   CheckGroundingResponse response = future.get();
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException