Class AgentsClient (4.4.0)

Service Description: Service for managing Agents.

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:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Agent response = agentsClient.getAgent(parent);
 }
 

Note: close() needs to be called on the AgentsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of AgentsSettings to create(). For example:

To customize credentials:

 AgentsSettings agentsSettings =
     AgentsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 AgentsClient agentsClient = AgentsClient.create(agentsSettings);
 

To customize the endpoint:

 AgentsSettings agentsSettings = AgentsSettings.newBuilder().setEndpoint(myEndpoint).build();
 AgentsClient agentsClient = AgentsClient.create(agentsSettings);
 

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

Constructs an instance of AgentsClient, 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.

Constructs an instance of AgentsClient with default settings.

Constructs an instance of AgentsClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

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

Deletes the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   DeleteAgentRequest request =
       DeleteAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
   agentsClient.deleteAgent(request);
 }
 

Deletes the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   agentsClient.deleteAgent(parent);
 }
 

Deletes the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   agentsClient.deleteAgent(parent);
 }
 

Deletes the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   agentsClient.deleteAgent(parent);
 }
 

Deletes the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   DeleteAgentRequest request =
       DeleteAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
   ApiFuture<Empty> future = agentsClient.deleteAgentCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ExportAgentRequest request =
      ExportAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .setAgentUri("agentUri1469149223")
          .build();
  ExportAgentResponse response = agentsClient.exportAgentAsync(request).get();
  }
  

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
  ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
  }
  

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ProjectName parent = ProjectName.of("[PROJECT]");
  ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
  }
  

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  String parent = ProjectName.of("[PROJECT]").toString();
  ExportAgentResponse response = agentsClient.exportAgentAsync(parent).get();
  }
  

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ExportAgentRequest request =
      ExportAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .setAgentUri("agentUri1469149223")
          .build();
  ApiFuture<Operation> future = agentsClient.exportAgentCallable().futureCall(request);
  // Do something.
  Operation response = future.get();
  }
  

Exports the specified agent to a ZIP file.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: ExportAgentResponse

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ExportAgentRequest request =
      ExportAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .setAgentUri("agentUri1469149223")
          .build();
  OperationFuture

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   GetAgentRequest request =
       GetAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
   Agent response = agentsClient.getAgent(request);
 }
 

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Agent response = agentsClient.getAgent(parent);
 }
 

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Agent response = agentsClient.getAgent(parent);
 }
 

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Agent response = agentsClient.getAgent(parent);
 }
 

Retrieves the specified agent.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   GetAgentRequest request =
       GetAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
   ApiFuture<Agent> future = agentsClient.getAgentCallable().futureCall(request);
   // Do something.
   Agent response = future.get();
 }
 

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

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   GetValidationResultRequest request =
       GetValidationResultRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ValidationResult response = agentsClient.getValidationResult(request);
 }
 

Gets agent validation result. Agent validation is performed during training time and is updated automatically when training is completed.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   GetValidationResultRequest request =
       GetValidationResultRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setLanguageCode("languageCode-2092349083")
           .build();
   ApiFuture

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when importing is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ImportAgentRequest request =
      ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  agentsClient.importAgentAsync(request).get();
  }
  

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when importing is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ImportAgentRequest request =
      ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  ApiFuture<Operation> future = agentsClient.importAgentCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Imports the specified agent from a ZIP file.

Uploads new intents and entity types without deleting the existing ones. Intents and entity types with the same name are replaced with the new versions from ImportAgentRequest. After the import, the imported draft agent will be trained automatically (unless disabled in agent settings). However, once the import is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when importing is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ImportAgentRequest request =
      ImportAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  OperationFuture

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when restoring is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  RestoreAgentRequest request =
      RestoreAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .build();
  agentsClient.restoreAgentAsync(request).get();
  }
  

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when restoring is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  RestoreAgentRequest request =
      RestoreAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .build();
  ApiFuture<Operation> future = agentsClient.restoreAgentCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Restores the specified agent from a ZIP file.

Replaces the current agent version with a new one. All the intents and entity types in the older version are deleted. After the restore, the restored draft agent will be trained automatically (unless disabled in agent settings). However, once the restore is done, training may not be completed yet. Please call TrainAgent and wait for the operation it returns in order to train explicitly.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  The operation only tracks when restoring is complete, not when it is done training.

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  RestoreAgentRequest request =
      RestoreAgentRequest.newBuilder()
          .setParent(ProjectName.of("[PROJECT]").toString())
          .build();
  OperationFuture

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   SearchAgentsRequest request =
       SearchAgentsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Agent element : agentsClient.searchAgents(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Agent element : agentsClient.searchAgents(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   SearchAgentsRequest request =
       SearchAgentsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     SearchAgentsResponse response = agentsClient.searchAgentsCallable().call(request);
     for (Agent element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

Returns the list of agents. Since there is at most one conversational agent per project, this method is useful primarily for listing all agents across projects the caller has access to. One can achieve that with a wildcard project collection id "-". Refer to List Sub-Collections.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   SearchAgentsRequest request =
       SearchAgentsRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Agent> future = agentsClient.searchAgentsPagedCallable().futureCall(request);
   // Do something.
   for (Agent element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   Agent agent = Agent.newBuilder().build();
   Agent response = agentsClient.setAgent(agent);
 }
 

Creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   SetAgentRequest request =
       SetAgentRequest.newBuilder()
           .setAgent(Agent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Agent response = agentsClient.setAgent(request);
 }
 

Creates/updates the specified agent.

Note: You should always train an agent prior to sending it queries. See the training documentation.

Sample code:

 try (AgentsClient agentsClient = AgentsClient.create()) {
   SetAgentRequest request =
       SetAgentRequest.newBuilder()
           .setAgent(Agent.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Agent> future = agentsClient.setAgentCallable().futureCall(request);
   // Do something.
   Agent response = future.get();
 }
 

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
  agentsClient.trainAgentAsync(parent).get();
  }
  

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  ProjectName parent = ProjectName.of("[PROJECT]");
  agentsClient.trainAgentAsync(parent).get();
  }
  

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  TrainAgentRequest request =
      TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  agentsClient.trainAgentAsync(request).get();
  }
  

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  String parent = ProjectName.of("[PROJECT]").toString();
  agentsClient.trainAgentAsync(parent).get();
  }
  

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  TrainAgentRequest request =
      TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  ApiFuture<Operation> future = agentsClient.trainAgentCallable().futureCall(request);
  // Do something.
  future.get();
  }
  

Trains the specified agent.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

- metadata: An empty Struct message

• response: An Empty message

  Note: You should always train an agent prior to sending it queries. See the training documentation.

  Sample code:

  
  try (AgentsClient agentsClient = AgentsClient.create()) {
  TrainAgentRequest request =
      TrainAgentRequest.newBuilder().setParent(ProjectName.of("[PROJECT]").toString()).build();
  OperationFuture