Struct Documents 

pub struct Documents { /* private fields */ }

Available on crate feature documents only.

Implements a client for the Dialogflow API.

Example

let client = Documents::builder().build().await?;
// use `client` to make requests to the Dialogflow API.

Service Description

Service for managing knowledge Documents.

Configuration

To configure Documents use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://dialogflow.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

Documents holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap Documents in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl Documents

pub fn builder() -> ClientBuilder

Returns a builder for Documents.

let client = Documents::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: Documents + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn list_documents(&self) -> ListDocuments

Returns the list of all documents of the knowledge base.

pub fn get_document(&self) -> GetDocument

Retrieves the specified document.

pub fn create_document(&self) -> CreateDocument

Creates a new document.

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

• metadata: KnowledgeOperationMetadata
• response: Document

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn import_documents(&self) -> ImportDocuments

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
• response: ImportDocumentsResponse

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_document(&self) -> DeleteDocument

Deletes the specified document.

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

• metadata: KnowledgeOperationMetadata
• response: An Empty message

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn update_document(&self) -> UpdateDocument

Updates the specified document.

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

• metadata: KnowledgeOperationMetadata
• response: Document

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn reload_document(&self) -> ReloadDocument

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
• response: Document

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn export_document(&self) -> ExportDocument

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
• response: Document

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for Documents

fn clone(&self) -> Documents

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Documents

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

Formats the value using the given formatter.