Class AgentsGrpc.AgentsBlockingStub (0.63.0)

public static final class AgentsGrpc.AgentsBlockingStub extends AbstractBlockingStub<AgentsGrpc.AgentsBlockingStub>

A stub to allow clients to do synchronous rpc calls to service Agents.

Service for managing Agents.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractBlockingStub > AgentsGrpc.AgentsBlockingStub

Inherited Members

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel)

io.grpc.stub.AbstractBlockingStub.<T>newStub(io.grpc.stub.AbstractStub.StubFactory<T>,io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.<T>withOption(io.grpc.CallOptions.Key<T>,T)

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

io.grpc.stub.AbstractStub.getCallOptions()

io.grpc.stub.AbstractStub.getChannel()

io.grpc.stub.AbstractStub.withCallCredentials(io.grpc.CallCredentials)

io.grpc.stub.AbstractStub.withChannel(io.grpc.Channel)

io.grpc.stub.AbstractStub.withCompression(java.lang.String)

io.grpc.stub.AbstractStub.withDeadline(io.grpc.Deadline)

io.grpc.stub.AbstractStub.withDeadlineAfter(long,java.util.concurrent.TimeUnit)

io.grpc.stub.AbstractStub.withExecutor(java.util.concurrent.Executor)

io.grpc.stub.AbstractStub.withInterceptors(io.grpc.ClientInterceptor...)

io.grpc.stub.AbstractStub.withMaxInboundMessageSize(int)

io.grpc.stub.AbstractStub.withMaxOutboundMessageSize(int)

io.grpc.stub.AbstractStub.withOnReadyThreshold(int)

io.grpc.stub.AbstractStub.withWaitForReady()

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)

Methods

build(Channel channel, CallOptions callOptions)

protected AgentsGrpc.AgentsBlockingStub build(Channel channel, CallOptions callOptions)

Parameters
Name	Description
`channel`	`io.grpc.Channel`
`callOptions`	`io.grpc.CallOptions`

Returns
Type	Description
`AgentsGrpc.AgentsBlockingStub`

Overrides

io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createAgent(CreateAgentRequest request)

public 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
`Agent`

deleteAgent(DeleteAgentRequest request)

public Empty deleteAgent(DeleteAgentRequest request)

Deletes the specified agent.

Parameter
Name	Description
`request`	`DeleteAgentRequest`

Returns
Type	Description
`Empty`

exportAgent(ExportAgentRequest request)

public 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:

metadata: An empty Struct message
response: ExportAgentResponse

Parameter
Name	Description
`request`	`ExportAgentRequest`

Returns
Type	Description
`Operation`

getAgent(GetAgentRequest request)

public Agent getAgent(GetAgentRequest request)

Retrieves the specified agent.

Parameter
Name	Description
`request`	`GetAgentRequest`

Returns
Type	Description
`Agent`

getAgentValidationResult(GetAgentValidationResultRequest request)

public 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
`AgentValidationResult`

getGenerativeSettings(GetGenerativeSettingsRequest request)

public GenerativeSettings getGenerativeSettings(GetGenerativeSettingsRequest request)

Gets the generative settings for the agent.

Parameter
Name	Description
`request`	`GetGenerativeSettingsRequest`

Returns
Type	Description
`GenerativeSettings`

listAgents(ListAgentsRequest request)

public ListAgentsResponse listAgents(ListAgentsRequest request)

Returns the list of all agents in the specified location.

Parameter
Name	Description
`request`	`ListAgentsRequest`

Returns
Type	Description
`ListAgentsResponse`

restoreAgent(RestoreAgentRequest request)

public 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:

metadata: An empty Struct message
response: An Empty message Note: You should always train a flow prior to sending it queries. See the training documentation.

Parameter
Name	Description
`request`	`RestoreAgentRequest`

Returns
Type	Description
`Operation`

updateAgent(UpdateAgentRequest request)

public 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
`Agent`

updateGenerativeSettings(UpdateGenerativeSettingsRequest request)

public GenerativeSettings updateGenerativeSettings(UpdateGenerativeSettingsRequest request)

Updates the generative settings for the agent.

Parameter
Name	Description
`request`	`UpdateGenerativeSettingsRequest`

Returns
Type	Description
`GenerativeSettings`

validateAgent(ValidateAgentRequest request)

public 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
`AgentValidationResult`