Class VertexRagServiceClient (3.56.0)

GitHub RepositoryProduct ReferenceREST DocumentationRPC Documentation

Service Description: A service for retrieving relevant contexts.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RagQuery query = RagQuery.newBuilder().build();
   RetrieveContextsResponse response = vertexRagServiceClient.retrieveContexts(parent, query);
 }

Note: close() needs to be called on the VertexRagServiceClient 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

RetrieveContexts

Retrieves relevant contexts for a query.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • retrieveContexts(RetrieveContextsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • retrieveContexts(LocationName parent, RagQuery query)

  • retrieveContexts(String parent, RagQuery query)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • retrieveContextsCallable()

AugmentPrompt

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • augmentPrompt(AugmentPromptRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • augmentPrompt(LocationName parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

  • augmentPrompt(String parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • augmentPromptCallable()

CorroborateContent

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.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • corroborateContent(CorroborateContentRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • corroborateContent(LocationName parent, Content content, List<Fact> facts)

  • corroborateContent(String parent, Content content, List<Fact> facts)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • corroborateContentCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

SetIamPolicy

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • setIamPolicy(SetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • setIamPolicyCallable()

GetIamPolicy

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getIamPolicy(GetIamPolicyRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getIamPolicyCallable()

TestIamPermissions

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • testIamPermissions(TestIamPermissionsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • testIamPermissionsCallable()

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 VertexRagServiceSettings 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
 VertexRagServiceSettings vertexRagServiceSettings =
     VertexRagServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VertexRagServiceClient vertexRagServiceClient =
     VertexRagServiceClient.create(vertexRagServiceSettings);

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
 VertexRagServiceSettings vertexRagServiceSettings =
     VertexRagServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VertexRagServiceClient vertexRagServiceClient =
     VertexRagServiceClient.create(vertexRagServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VertexRagServiceClient

Static Methods

create()

public static final VertexRagServiceClient create()

Constructs an instance of VertexRagServiceClient with default settings.

Returns
Type Description
VertexRagServiceClient
Exceptions
Type Description
IOException

create(VertexRagServiceSettings settings)

public static final VertexRagServiceClient create(VertexRagServiceSettings settings)

Constructs an instance of VertexRagServiceClient, 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 VertexRagServiceSettings
Returns
Type Description
VertexRagServiceClient
Exceptions
Type Description
IOException

create(VertexRagServiceStub stub)

public static final VertexRagServiceClient create(VertexRagServiceStub stub)

Constructs an instance of VertexRagServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(VertexRagServiceSettings).

Parameter
Name Description
stub VertexRagServiceStub
Returns
Type Description
VertexRagServiceClient

Constructors

VertexRagServiceClient(VertexRagServiceSettings settings)

protected VertexRagServiceClient(VertexRagServiceSettings settings)

Constructs an instance of VertexRagServiceClient, 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 VertexRagServiceSettings

VertexRagServiceClient(VertexRagServiceStub stub)

protected VertexRagServiceClient(VertexRagServiceStub stub)
Parameter
Name Description
stub VertexRagServiceStub

Methods

augmentPrompt(AugmentPromptRequest request)

public final AugmentPromptResponse augmentPrompt(AugmentPromptRequest request)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   AugmentPromptRequest request =
       AugmentPromptRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllContents(new ArrayList<Content>())
           .setModel(AugmentPromptRequest.Model.newBuilder().build())
           .build();
   AugmentPromptResponse response = vertexRagServiceClient.augmentPrompt(request);
 }
Parameter
Name Description
request AugmentPromptRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
AugmentPromptResponse

augmentPrompt(LocationName parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

public final AugmentPromptResponse augmentPrompt(LocationName parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   AugmentPromptRequest.Model model = AugmentPromptRequest.Model.newBuilder().build();
   VertexRagStore vertexRagStore = VertexRagStore.newBuilder().build();
   AugmentPromptResponse response =
       vertexRagServiceClient.augmentPrompt(parent, model, vertexRagStore);
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
model AugmentPromptRequest.Model

Optional. Metadata of the backend deployed model.
vertexRagStore VertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.
Returns
Type Description
AugmentPromptResponse

augmentPrompt(String parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

public final AugmentPromptResponse augmentPrompt(String parent, AugmentPromptRequest.Model model, VertexRagStore vertexRagStore)

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   AugmentPromptRequest.Model model = AugmentPromptRequest.Model.newBuilder().build();
   VertexRagStore vertexRagStore = VertexRagStore.newBuilder().build();
   AugmentPromptResponse response =
       vertexRagServiceClient.augmentPrompt(parent, model, vertexRagStore);
 }
Parameters
Name Description
parent String

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
model AugmentPromptRequest.Model

Optional. Metadata of the backend deployed model.
vertexRagStore VertexRagStore

Optional. Retrieves contexts from the Vertex RagStore.
Returns
Type Description
AugmentPromptResponse

augmentPromptCallable()

public final UnaryCallable<AugmentPromptRequest,AugmentPromptResponse> augmentPromptCallable()

Given an input prompt, it returns augmented prompt from vertex rag store to guide LLM towards generating grounded responses.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   AugmentPromptRequest request =
       AugmentPromptRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .addAllContents(new ArrayList<Content>())
           .setModel(AugmentPromptRequest.Model.newBuilder().build())
           .build();
   ApiFuture<AugmentPromptResponse> future =
       vertexRagServiceClient.augmentPromptCallable().futureCall(request);
   // Do something.
   AugmentPromptResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<AugmentPromptRequest,AugmentPromptResponse>

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

close()

public final void close()

corroborateContent(CorroborateContentRequest request)

public final CorroborateContentResponse corroborateContent(CorroborateContentRequest request)

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.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   CorroborateContentRequest request =
       CorroborateContentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setContent(Content.newBuilder().build())
           .addAllFacts(new ArrayList<Fact>())
           .setParameters(CorroborateContentRequest.Parameters.newBuilder().build())
           .build();
   CorroborateContentResponse response = vertexRagServiceClient.corroborateContent(request);
 }
Parameter
Name Description
request CorroborateContentRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
CorroborateContentResponse

corroborateContent(LocationName parent, Content content, List<Fact> facts)

public final CorroborateContentResponse corroborateContent(LocationName parent, Content content, List<Fact> facts)

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.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Content content = Content.newBuilder().build();
   List<Fact> facts = new ArrayList<>();
   CorroborateContentResponse response =
       vertexRagServiceClient.corroborateContent(parent, content, facts);
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
content Content

Optional. Input content to corroborate, only text format is supported for now.
facts List<Fact>

Optional. Facts used to generate the text can also be used to corroborate the text.
Returns
Type Description
CorroborateContentResponse

corroborateContent(String parent, Content content, List<Fact> facts)

public final CorroborateContentResponse corroborateContent(String parent, Content content, List<Fact> facts)

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.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Content content = Content.newBuilder().build();
   List<Fact> facts = new ArrayList<>();
   CorroborateContentResponse response =
       vertexRagServiceClient.corroborateContent(parent, content, facts);
 }
Parameters
Name Description
parent String

Required. The resource name of the Location from which to corroborate text. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
content Content

Optional. Input content to corroborate, only text format is supported for now.
facts List<Fact>

Optional. Facts used to generate the text can also be used to corroborate the text.
Returns
Type Description
CorroborateContentResponse

corroborateContentCallable()

public final UnaryCallable<CorroborateContentRequest,CorroborateContentResponse> corroborateContentCallable()

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.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   CorroborateContentRequest request =
       CorroborateContentRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setContent(Content.newBuilder().build())
           .addAllFacts(new ArrayList<Fact>())
           .setParameters(CorroborateContentRequest.Parameters.newBuilder().build())
           .build();
   ApiFuture<CorroborateContentResponse> future =
       vertexRagServiceClient.corroborateContentCallable().futureCall(request);
   // Do something.
   CorroborateContentResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<CorroborateContentRequest,CorroborateContentResponse>

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   Policy response = vertexRagServiceClient.getIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.GetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the access control policy for a resource. Returns an empty policyif the resource exists and does not have a policy set.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   GetIamPolicyRequest request =
       GetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setOptions(GetPolicyOptions.newBuilder().build())
           .build();
   ApiFuture<Policy> future = vertexRagServiceClient.getIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = vertexRagServiceClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = vertexRagServiceClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final VertexRagServiceSettings getSettings()
Returns
Type Description
VertexRagServiceSettings

getStub()

public VertexRagServiceStub getStub()
Returns
Type Description
VertexRagServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final VertexRagServiceClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : vertexRagServiceClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
VertexRagServiceClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         vertexRagServiceClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,VertexRagServiceClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       vertexRagServiceClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

retrieveContexts(LocationName parent, RagQuery query)

public final RetrieveContextsResponse retrieveContexts(LocationName parent, RagQuery query)

Retrieves relevant contexts for a query.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   RagQuery query = RagQuery.newBuilder().build();
   RetrieveContextsResponse response = vertexRagServiceClient.retrieveContexts(parent, query);
 }
Parameters
Name Description
parent LocationName

Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
query RagQuery

Required. Single RAG retrieve query.
Returns
Type Description
RetrieveContextsResponse

retrieveContexts(RetrieveContextsRequest request)

public final RetrieveContextsResponse retrieveContexts(RetrieveContextsRequest request)

Retrieves relevant contexts for a query.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   RetrieveContextsRequest request =
       RetrieveContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .build();
   RetrieveContextsResponse response = vertexRagServiceClient.retrieveContexts(request);
 }
Parameter
Name Description
request RetrieveContextsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
RetrieveContextsResponse

retrieveContexts(String parent, RagQuery query)

public final RetrieveContextsResponse retrieveContexts(String parent, RagQuery query)

Retrieves relevant contexts for a query.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   RagQuery query = RagQuery.newBuilder().build();
   RetrieveContextsResponse response = vertexRagServiceClient.retrieveContexts(parent, query);
 }
Parameters
Name Description
parent String

Required. The resource name of the Location from which to retrieve RagContexts. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.
query RagQuery

Required. Single RAG retrieve query.
Returns
Type Description
RetrieveContextsResponse

retrieveContextsCallable()

public final UnaryCallable<RetrieveContextsRequest,RetrieveContextsResponse> retrieveContextsCallable()

Retrieves relevant contexts for a query.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   RetrieveContextsRequest request =
       RetrieveContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .build();
   ApiFuture<RetrieveContextsResponse> future =
       vertexRagServiceClient.retrieveContextsCallable().futureCall(request);
   // Do something.
   RetrieveContextsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<RetrieveContextsRequest,RetrieveContextsResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Policy response = vertexRagServiceClient.setIamPolicy(request);
 }
Parameter
Name Description
request com.google.iam.v1.SetIamPolicyRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the access control policy on the specified resource. Replacesany existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIEDerrors.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   SetIamPolicyRequest request =
       SetIamPolicyRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .setPolicy(Policy.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Policy> future = vertexRagServiceClient.setIamPolicyCallable().futureCall(request);
   // Do something.
   Policy response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   TestIamPermissionsResponse response = vertexRagServiceClient.testIamPermissions(request);
 }
Parameter
Name Description
request com.google.iam.v1.TestIamPermissionsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified resource. If theresource does not exist, this will return an empty set ofpermissions, not a NOT_FOUND error.

Note: This operation is designed to be used for buildingpermission-aware UIs and command-line tools, not for authorizationchecking. This operation may "fail open" without warning.

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 (VertexRagServiceClient vertexRagServiceClient = VertexRagServiceClient.create()) {
   TestIamPermissionsRequest request =
       TestIamPermissionsRequest.newBuilder()
           .setResource(
               EndpointName.ofProjectLocationEndpointName(
                       "[PROJECT]", "[LOCATION]", "[ENDPOINT]")
                   .toString())
           .addAllPermissions(new ArrayList<String>())
           .build();
   ApiFuture<TestIamPermissionsResponse> future =
       vertexRagServiceClient.testIamPermissionsCallable().futureCall(request);
   // Do something.
   TestIamPermissionsResponse response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>