Class AgentsGrpc.AgentsImplBase (4.11.0)

public abstract static class AgentsGrpc.AgentsImplBase implements BindableService

Service for managing Agents.

Inheritance

java.lang.Object > AgentsGrpc.AgentsImplBase

Implements

io.grpc.BindableService

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

AgentsImplBase()

public AgentsImplBase()

Methods

bindService()

public final ServerServiceDefinition bindService()

Returns

Type	Description
io.grpc.ServerServiceDefinition

deleteAgent(DeleteAgentRequest request, StreamObserver<Empty> responseObserver)

public void deleteAgent(DeleteAgentRequest request, StreamObserver<Empty> responseObserver)

Deletes the specified agent.

Parameters

Name	Description
request	`DeleteAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Empty>`

exportAgent(ExportAgentRequest request, StreamObserver<Operation> responseObserver)

public void exportAgent(ExportAgentRequest request, StreamObserver<Operation> responseObserver)

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

Parameters

Name	Description
request	`ExportAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

getAgent(GetAgentRequest request, StreamObserver<Agent> responseObserver)

public void getAgent(GetAgentRequest request, StreamObserver<Agent> responseObserver)

Retrieves the specified agent.

Parameters

Name	Description
request	`GetAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Agent>`

getValidationResult(GetValidationResultRequest request, StreamObserver<ValidationResult> responseObserver)

public void getValidationResult(GetValidationResultRequest request, StreamObserver<ValidationResult> responseObserver)

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

Parameters

Name	Description
request	`GetValidationResultRequest`
responseObserver	`io.grpc.stub.StreamObserver<ValidationResult>`

importAgent(ImportAgentRequest request, StreamObserver<Operation> responseObserver)

public void importAgent(ImportAgentRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`ImportAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

restoreAgent(RestoreAgentRequest request, StreamObserver<Operation> responseObserver)

public void restoreAgent(RestoreAgentRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`RestoreAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`

searchAgents(SearchAgentsRequest request, StreamObserver<SearchAgentsResponse> responseObserver)

public void searchAgents(SearchAgentsRequest request, StreamObserver<SearchAgentsResponse> responseObserver)

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.

Parameters

Name	Description
request	`SearchAgentsRequest`
responseObserver	`io.grpc.stub.StreamObserver<SearchAgentsResponse>`

setAgent(SetAgentRequest request, StreamObserver<Agent> responseObserver)

public void setAgent(SetAgentRequest request, StreamObserver<Agent> responseObserver)

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

Parameters

Name	Description
request	`SetAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Agent>`

trainAgent(TrainAgentRequest request, StreamObserver<Operation> responseObserver)

public void trainAgent(TrainAgentRequest request, StreamObserver<Operation> responseObserver)

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.

Parameters

Name	Description
request	`TrainAgentRequest`
responseObserver	`io.grpc.stub.StreamObserver<Operation>`