Document class

Document class

Represents the base class for documents added to an index from a file system, stream, or structure, and provides static methods for creating documents from different source types.

Learn more:

The Document type exposes the following members:

Methods

Method Description
create_from_file Creates a document from a file.
create_from_stream Creates a document from a stream.
create_from_structure Creates a document from a structure that is an array of text fields.
create_lazy Creates a lazy-loaded document.
to_string Returns a str that represents the current Document.

Properties

Property Description
additional_fields The additional fields for the document.
attributes The attributes of the document.
document_key The document key that is used to identify the document within an index.
document_source_kind The document source kind.
extension The extension used for this document type.
is_lazy The document is loaded lazily, indicating whether it is loaded as needed.
modification_date The last modification date of the document.

Guides

Task guides that use Document:

See Also