Interface AgentsGrpc.AsyncService (0.52.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 flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestCreateAgentRequest
responseObserverio.grpc.stub.StreamObserver<Agent>

deleteAgent(DeleteAgentRequest request, StreamObserver<Empty> responseObserver)

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

Deletes the specified agent.

Parameters
NameDescription
requestDeleteAgentRequest
responseObserverio.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
NameDescription
requestExportAgentRequest
responseObserverio.grpc.stub.StreamObserver<Operation>

getAgent(GetAgentRequest request, StreamObserver<Agent> responseObserver)

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

Retrieves the specified agent.

Parameters
NameDescription
requestGetAgentRequest
responseObserverio.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
NameDescription
requestGetAgentValidationResultRequest
responseObserverio.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
NameDescription
requestGetGenerativeSettingsRequest
responseObserverio.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
NameDescription
requestListAgentsRequest
responseObserverio.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
NameDescription
requestRestoreAgentRequest
responseObserverio.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 flows prior to sending them queries. See the training documentation.

Parameters
NameDescription
requestUpdateAgentRequest
responseObserverio.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
NameDescription
requestUpdateGenerativeSettingsRequest
responseObserverio.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
NameDescription
requestValidateAgentRequest
responseObserverio.grpc.stub.StreamObserver<AgentValidationResult>