Struct google_api_proto::google::cloud::dialogflow::v2::documents_client::DocumentsClient

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

Service for managing knowledge [Documents][google.cloud.dialogflow.v2.Document].

Implementations

impl<T> DocumentsClient<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, ) -> DocumentsClient<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 list_documents( &mut self, request: impl IntoRequest<ListDocumentsRequest>, ) -> Result<Response<ListDocumentsResponse>, Status>

Returns the list of all documents of the knowledge base.

pub async fn get_document( &mut self, request: impl IntoRequest<GetDocumentRequest>, ) -> Result<Response<Document>, Status>

Retrieves the specified document.

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

Creates a new document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: [Document][google.cloud.dialogflow.v2.Document]

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

Creates documents by importing data from external sources. Dialogflow supports up to 350 documents in each request. If you try to import more, Dialogflow will return an error.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: [ImportDocumentsResponse][google.cloud.dialogflow.v2.ImportDocumentsResponse]

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

Deletes the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: An Empty message

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

Updates the specified document.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: [Document][google.cloud.dialogflow.v2.Document]

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

Reloads the specified document from its specified source, content_uri or content. The previously loaded content of the document will be deleted. Note: Even when the content of the document has not changed, there still may be side effects because of internal implementation changes.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: [Document][google.cloud.dialogflow.v2.Document]

Note: The projects.agent.knowledgeBases.documents resource is deprecated; only use projects.knowledgeBases.documents.

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

Exports a smart messaging candidate document into the specified destination.

This method is a long-running operation. The returned Operation type has the following method-specific fields:

• metadata: [KnowledgeOperationMetadata][google.cloud.dialogflow.v2.KnowledgeOperationMetadata]
• response: [Document][google.cloud.dialogflow.v2.Document]

Trait Implementations

impl<T: Clone> Clone for DocumentsClient<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for DocumentsClient<T>

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

Formats the value using the given formatter.