Class AgentsGrpc.AgentsFutureStub (0.45.0)

public static final class AgentsGrpc.AgentsFutureStub extends AbstractFutureStub<AgentsGrpc.AgentsFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service Agents.

Service for managing Agents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > AgentsGrpc.AgentsFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected AgentsGrpc.AgentsFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
AgentsGrpc.AgentsFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAgent(CreateAgentRequest request)

public ListenableFuture<Agent> createAgent(CreateAgentRequest request)

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

Parameter
Name Description
request CreateAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Agent>

deleteAgent(DeleteAgentRequest request)

public ListenableFuture<Empty> deleteAgent(DeleteAgentRequest request)

Deletes the specified agent.

Parameter
Name Description
request DeleteAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

exportAgent(ExportAgentRequest request)

public ListenableFuture<Operation> exportAgent(ExportAgentRequest request)

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:

Parameter
Name Description
request ExportAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getAgent(GetAgentRequest request)

public ListenableFuture<Agent> getAgent(GetAgentRequest request)

Retrieves the specified agent.

Parameter
Name Description
request GetAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Agent>

getAgentValidationResult(GetAgentValidationResultRequest request)

public ListenableFuture<AgentValidationResult> getAgentValidationResult(GetAgentValidationResultRequest request)

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

Parameter
Name Description
request GetAgentValidationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AgentValidationResult>

getGenerativeSettings(GetGenerativeSettingsRequest request)

public ListenableFuture<GenerativeSettings> getGenerativeSettings(GetGenerativeSettingsRequest request)

Gets the generative settings for the agent.

Parameter
Name Description
request GetGenerativeSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerativeSettings>

listAgents(ListAgentsRequest request)

public ListenableFuture<ListAgentsResponse> listAgents(ListAgentsRequest request)

Returns the list of all agents in the specified location.

Parameter
Name Description
request ListAgentsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListAgentsResponse>

restoreAgent(RestoreAgentRequest request)

public ListenableFuture<Operation> restoreAgent(RestoreAgentRequest request)

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:

Parameter
Name Description
request RestoreAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

updateAgent(UpdateAgentRequest request)

public ListenableFuture<Agent> updateAgent(UpdateAgentRequest request)

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

Parameter
Name Description
request UpdateAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Agent>

updateGenerativeSettings(UpdateGenerativeSettingsRequest request)

public ListenableFuture<GenerativeSettings> updateGenerativeSettings(UpdateGenerativeSettingsRequest request)

Updates the generative settings for the agent.

Parameter
Name Description
request UpdateGenerativeSettingsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<GenerativeSettings>

validateAgent(ValidateAgentRequest request)

public ListenableFuture<AgentValidationResult> validateAgent(ValidateAgentRequest request)

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.

Parameter
Name Description
request ValidateAgentRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<AgentValidationResult>