Class AgentsGrpc.AgentsBlockingStub (4.52.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.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)

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

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`

getValidationResult(GetValidationResultRequest request)

public ValidationResult getValidationResult(GetValidationResultRequest request)

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

Parameter
Name	Description
`request`	`GetValidationResultRequest`

Returns
Type	Description
`ValidationResult`

importAgent(ImportAgentRequest request)

public Operation importAgent(ImportAgentRequest request)

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.

Parameter
Name	Description
`request`	`ImportAgentRequest`

Returns
Type	Description
`Operation`

restoreAgent(RestoreAgentRequest request)

public Operation restoreAgent(RestoreAgentRequest request)

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.

Parameter
Name	Description
`request`	`RestoreAgentRequest`

Returns
Type	Description
`Operation`

searchAgents(SearchAgentsRequest request)

public SearchAgentsResponse searchAgents(SearchAgentsRequest request)

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.

Parameter
Name	Description
`request`	`SearchAgentsRequest`

Returns
Type	Description
`SearchAgentsResponse`

setAgent(SetAgentRequest request)

public Agent setAgent(SetAgentRequest request)

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

Parameter
Name	Description
`request`	`SetAgentRequest`

Returns
Type	Description
`Agent`

trainAgent(TrainAgentRequest request)

public Operation trainAgent(TrainAgentRequest request)

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.

Parameter
Name	Description
`request`	`TrainAgentRequest`

Returns
Type	Description
`Operation`