Struct google_api_proto::google::cloud::dialogflow::v2::agents_client::AgentsClient

pub struct AgentsClient<T> { /* private fields */ }

Service for managing [Agents][google.cloud.dialogflow.v2.Agent].

Implementations

impl<T> AgentsClient<T>

where T: GrpcService<BoxBody>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

pub fn new(inner: T) -> Self

pub fn with_origin(inner: T, origin: Uri) -> Self

pub fn with_interceptor<F>( inner: T, interceptor: F, ) -> AgentsClient<InterceptedService<T, F>>

where F: Interceptor, T::ResponseBody: Default, T: Service<Request<BoxBody>, Response = Response<<T as GrpcService<BoxBody>>::ResponseBody>>, <T as Service<Request<BoxBody>>>::Error: Into<StdError> + Send + Sync,

pub fn send_compressed(self, encoding: CompressionEncoding) -> Self

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed(self, encoding: CompressionEncoding) -> Self

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> Self

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> Self

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get_agent( &mut self, request: impl IntoRequest<GetAgentRequest>, ) -> Result<Response<Agent>, Status>

Retrieves the specified agent.

pub async fn set_agent( &mut self, request: impl IntoRequest<SetAgentRequest>, ) -> Result<Response<Agent>, Status>

Creates/updates the specified agent.

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

pub async fn delete_agent( &mut self, request: impl IntoRequest<DeleteAgentRequest>, ) -> Result<Response<()>, Status>

Deletes the specified agent.

pub async fn search_agents( &mut self, request: impl IntoRequest<SearchAgentsRequest>, ) -> Result<Response<SearchAgentsResponse>, Status>

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.

pub async fn train_agent( &mut self, request: impl IntoRequest<TrainAgentRequest>, ) -> Result<Response<Operation>, Status>

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.

pub async fn export_agent( &mut self, request: impl IntoRequest<ExportAgentRequest>, ) -> Result<Response<Operation>, Status>

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][google.cloud.dialogflow.v2.ExportAgentResponse]

pub async fn import_agent( &mut self, request: impl IntoRequest<ImportAgentRequest>, ) -> Result<Response<Operation>, Status>

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][google.cloud.dialogflow.v2.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][google.cloud.dialogflow.v2.Agents.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.

pub async fn restore_agent( &mut self, request: impl IntoRequest<RestoreAgentRequest>, ) -> Result<Response<Operation>, Status>

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][google.cloud.dialogflow.v2.Agents.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.

pub async fn get_validation_result( &mut self, request: impl IntoRequest<GetValidationResultRequest>, ) -> Result<Response<ValidationResult>, Status>

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

Trait Implementations

impl<T: Clone> Clone for AgentsClient<T>

fn clone(&self) -> AgentsClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for AgentsClient<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.