Package com.google.cloud.aiplatform.v1beta1

Class VertexRagServiceClient

java.lang.Object
com.google.cloud.aiplatform.v1beta1.VertexRagServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@BetaApi @Generated("by gapic-generator-java") public class VertexRagServiceClient extends Object implements BackgroundResource
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()

AskContexts

Agentic Retrieval Ask API for RAG.

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

  • askContexts(AskContextsRequest request)

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

  • askContexts(LocationName parent, RagQuery query)

  • askContexts(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.

  • askContextsCallable()

AsyncRetrieveContexts

Asynchronous API to retrieves relevant contexts for a query.

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

  • asyncRetrieveContextsAsync(AsyncRetrieveContextsRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • asyncRetrieveContextsAsync(LocationName parent, RagQuery query)

  • asyncRetrieveContextsAsync(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.

  • asyncRetrieveContextsOperationCallable()

  • asyncRetrieveContextsCallable()

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_DENIED`errors.

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.

  • Constructor Details

    • VertexRagServiceClient

      protected VertexRagServiceClient(VertexRagServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • VertexRagServiceClient

      protected VertexRagServiceClient(VertexRagServiceStub stub)

  • Method Details

    • create

      public static final VertexRagServiceClient create() throws IOException
      Constructs an instance of VertexRagServiceClient with default settings.
      Throws:
      IOException

    • create

      public static final VertexRagServiceClient create(VertexRagServiceSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final VertexRagServiceSettings getSettings()

    • getStub

      public VertexRagServiceStub getStub()

    • getOperationsClient

      public final OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • retrieveContexts

      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:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • retrieveContexts

      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:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • retrieveContexts

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • augmentPrompt

      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:
      parent - 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 - Optional. Metadata of the backend deployed model.
      vertexRagStore - Optional. Retrieves contexts from the Vertex RagStore.
      Throws:
      ApiException - if the remote call fails

    • augmentPrompt

      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:
      parent - 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 - Optional. Metadata of the backend deployed model.
      vertexRagStore - Optional. Retrieves contexts from the Vertex RagStore.
      Throws:
      ApiException - if the remote call fails

    • augmentPrompt

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • corroborateContent

      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:
      parent - 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 - Optional. Input content to corroborate, only text format is supported for now.
      facts - Optional. Facts used to generate the text can also be used to corroborate the text.
      Throws:
      ApiException - if the remote call fails

    • corroborateContent

      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:
      parent - 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 - Optional. Input content to corroborate, only text format is supported for now.
      facts - Optional. Facts used to generate the text can also be used to corroborate the text.
      Throws:
      ApiException - if the remote call fails

    • corroborateContent

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • askContexts

      public final AskContextsResponse askContexts(LocationName parent, RagQuery query)
      Agentic Retrieval Ask API for RAG.

      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();
   AskContextsResponse response = vertexRagServiceClient.askContexts(parent, query);
 }
      Parameters:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • askContexts

      public final AskContextsResponse askContexts(String parent, RagQuery query)
      Agentic Retrieval Ask API for RAG.

      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();
   AskContextsResponse response = vertexRagServiceClient.askContexts(parent, query);
 }
      Parameters:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • askContexts

      public final AskContextsResponse askContexts(AskContextsRequest request)
      Agentic Retrieval Ask API for RAG.

      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()) {
   AskContextsRequest request =
       AskContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .addAllTools(new ArrayList<Tool>())
           .build();
   AskContextsResponse response = vertexRagServiceClient.askContexts(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • askContextsCallable

      public final UnaryCallable<AskContextsRequest,AskContextsResponse> askContextsCallable()
      Agentic Retrieval Ask API for RAG.

      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()) {
   AskContextsRequest request =
       AskContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .addAllTools(new ArrayList<Tool>())
           .build();
   ApiFuture<AskContextsResponse> future =
       vertexRagServiceClient.askContextsCallable().futureCall(request);
   // Do something.
   AskContextsResponse response = future.get();
 }

    • asyncRetrieveContextsAsync

      public final OperationFuture<AsyncRetrieveContextsResponse,AsyncRetrieveContextsOperationMetadata> asyncRetrieveContextsAsync(LocationName parent, RagQuery query)
      Asynchronous API to 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();
   AsyncRetrieveContextsResponse response =
       vertexRagServiceClient.asyncRetrieveContextsAsync(parent, query).get();
 }
      Parameters:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • asyncRetrieveContextsAsync

      public final OperationFuture<AsyncRetrieveContextsResponse,AsyncRetrieveContextsOperationMetadata> asyncRetrieveContextsAsync(String parent, RagQuery query)
      Asynchronous API to 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();
   AsyncRetrieveContextsResponse response =
       vertexRagServiceClient.asyncRetrieveContextsAsync(parent, query).get();
 }
      Parameters:
      parent - 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 - Required. Single RAG retrieve query.
      Throws:
      ApiException - if the remote call fails

    • asyncRetrieveContextsAsync

      public final OperationFuture<AsyncRetrieveContextsResponse,AsyncRetrieveContextsOperationMetadata> asyncRetrieveContextsAsync(AsyncRetrieveContextsRequest request)
      Asynchronous API to 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()) {
   AsyncRetrieveContextsRequest request =
       AsyncRetrieveContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .addAllTools(new ArrayList<Tool>())
           .build();
   AsyncRetrieveContextsResponse response =
       vertexRagServiceClient.asyncRetrieveContextsAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • asyncRetrieveContextsOperationCallable

      public final OperationCallable<AsyncRetrieveContextsRequest,AsyncRetrieveContextsResponse,AsyncRetrieveContextsOperationMetadata> asyncRetrieveContextsOperationCallable()
      Asynchronous API to 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()) {
   AsyncRetrieveContextsRequest request =
       AsyncRetrieveContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .addAllTools(new ArrayList<Tool>())
           .build();
   OperationFuture<AsyncRetrieveContextsResponse, AsyncRetrieveContextsOperationMetadata>
       future =
           vertexRagServiceClient.asyncRetrieveContextsOperationCallable().futureCall(request);
   // Do something.
   AsyncRetrieveContextsResponse response = future.get();
 }

    • asyncRetrieveContextsCallable

      public final UnaryCallable<AsyncRetrieveContextsRequest,Operation> asyncRetrieveContextsCallable()
      Asynchronous API to 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()) {
   AsyncRetrieveContextsRequest request =
       AsyncRetrieveContextsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setQuery(RagQuery.newBuilder().build())
           .addAllTools(new ArrayList<Tool>())
           .build();
   ApiFuture<Operation> future =
       vertexRagServiceClient.asyncRetrieveContextsCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • listLocations

      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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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);
   }
 }

    • 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;
     }
   }
 }

    • getLocation

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • setIamPolicy

      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_DENIED`errors.

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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_DENIED`errors.

      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();
 }

    • getIamPolicy

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • testIamPermissions

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException