Interface AgentsGrpc.AsyncService (0.51.0)

public static interface AgentsGrpc.AsyncService

Service for managing Agents.

Methods

createAgent(CreateAgentRequest request, StreamObserver<Agent> responseObserver)

public default void createAgent(CreateAgentRequest request, StreamObserver<Agent> responseObserver)

Creates an agent in the specified location. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name Description
request CreateAgentRequest
responseObserver io.grpc.stub.StreamObserver<Agent>

deleteAgent(DeleteAgentRequest request, StreamObserver<Empty> responseObserver)

public default 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 default void exportAgent(ExportAgentRequest request, StreamObserver<Operation> responseObserver)

Exports the specified agent to a binary file. This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

getAgent(GetAgentRequest request, StreamObserver<Agent> responseObserver)

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

Retrieves the specified agent.

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

getAgentValidationResult(GetAgentValidationResultRequest request, StreamObserver<AgentValidationResult> responseObserver)

public default void getAgentValidationResult(GetAgentValidationResultRequest request, StreamObserver<AgentValidationResult> responseObserver)

Gets the latest agent validation result. Agent validation is performed when ValidateAgent is called.

Parameters
Name Description
request GetAgentValidationResultRequest
responseObserver io.grpc.stub.StreamObserver<AgentValidationResult>

getGenerativeSettings(GetGenerativeSettingsRequest request, StreamObserver<GenerativeSettings> responseObserver)

public default void getGenerativeSettings(GetGenerativeSettingsRequest request, StreamObserver<GenerativeSettings> responseObserver)

Gets the generative settings for the agent.

Parameters
Name Description
request GetGenerativeSettingsRequest
responseObserver io.grpc.stub.StreamObserver<GenerativeSettings>

listAgents(ListAgentsRequest request, StreamObserver<ListAgentsResponse> responseObserver)

public default void listAgents(ListAgentsRequest request, StreamObserver<ListAgentsResponse> responseObserver)

Returns the list of all agents in the specified location.

Parameters
Name Description
request ListAgentsRequest
responseObserver io.grpc.stub.StreamObserver<ListAgentsResponse>

restoreAgent(RestoreAgentRequest request, StreamObserver<Operation> responseObserver)

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

Restores the specified agent from a binary file. Replaces the current agent with a new one. Note that all existing resources in agent (e.g. intents, entity types, flows) will be removed. This method is a long-running operation. The returned Operation type has the following method-specific fields:

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

updateAgent(UpdateAgentRequest request, StreamObserver<Agent> responseObserver)

public default void updateAgent(UpdateAgentRequest request, StreamObserver<Agent> responseObserver)

Updates the specified agent. Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameters
Name Description
request UpdateAgentRequest
responseObserver io.grpc.stub.StreamObserver<Agent>

updateGenerativeSettings(UpdateGenerativeSettingsRequest request, StreamObserver<GenerativeSettings> responseObserver)

public default void updateGenerativeSettings(UpdateGenerativeSettingsRequest request, StreamObserver<GenerativeSettings> responseObserver)

Updates the generative settings for the agent.

Parameters
Name Description
request UpdateGenerativeSettingsRequest
responseObserver io.grpc.stub.StreamObserver<GenerativeSettings>

validateAgent(ValidateAgentRequest request, StreamObserver<AgentValidationResult> responseObserver)

public default void validateAgent(ValidateAgentRequest request, StreamObserver<AgentValidationResult> responseObserver)

Validates the specified agent and creates or updates validation results. The agent in draft version is validated. Please call this API after the training is completed to get the complete validation results.

Parameters
Name Description
request ValidateAgentRequest
responseObserver io.grpc.stub.StreamObserver<AgentValidationResult>