Namespace LMKit.Data
Namespaces
Classes
- Attachment
Represents a file attachment with its content, name, MIME type, and size.
Supported Formats: PNG, BMP, GIF, PSD, PIC, JPEG, PNM, HDR, TGA, WEBP, TIFF, TXT, HTML, PDF, DOCX, XLSX, PPTX, EML, MBOX.
- AttachmentReference
Represents a reference to an attachment with an optional page index specification.
- DataFilter
Provides filtering functionality for DataSource and Section objects.
- DataSource
Represents a repository that encapsulates content from diverse data sources, including text, images, documents, web pages, and other data-rich environments. It provides a unified interface for consistent interaction with various types of data.
- DataSource.VectorEntry
Represents an entry pairing a vector embedding with its originating raw payload.
- ImagePartition
Represents an image partition of a Section, containing the embedding of a single image. This class encapsulates details such as the image identifier (payload) and its associated embedding vector.
- LoadWarning
Represents a warning encountered while loading a DataSource with partial load enabled.
- Metadata
Represents a single immutable metadata entry consisting of a key and a value. This class is used to store additional information in a structured form.
- MetadataCollection
Represents a collection of metadata entries, each consisting of a key and a value. This class provides methods to manage metadata efficiently, allowing addition, removal, and key-based queries.
- MetadataFilter
A metadata filter expression evaluated against the string key/value metadata attached to stored entries. A filter is a tree: comparison nodes test one key against one or more typed values (MetadataFilterValue), and composite nodes combine children with And or Or.
- MetadataFilter.Comparison
A comparison node: tests the metadata value stored under Key against this node's typed value(s) with a single operator.
- Partition
Represents a logical subdivision of a Section, containing a fragment of content, either text or image, for which embedding vectors have been generated. Partitions track their position within the parent section and expose payload content and embeddings.
- Section
Represents a section of a DataSource repository, encapsulating a unique segment that contains text or image partitions and associated metadata.
- TextPartition
Represents a text partition (or chunk of text) of a Section.
This class encapsulates the text details such as tokens, embeddings, and the mode used for splitting.
Structs
- MetadataFilterValue
A typed comparison value carried by a MetadataFilter comparison node. Metadata values are stored as strings; the value's Kind selects the comparison domain (text, number, boolean, or date), and stored strings that cannot be interpreted in that domain never match.
Interfaces
- ISerializableData
Defines methods for serializing an object into a binary format. Implementers of this interface provide mechanisms to convert an object's state into a binary representation, which can be stored or transmitted.
Enums
- ElementType
Enumerates the various data types that an element can represent, including primitive types, arrays, and complex objects.
- MetadataFilterOperator
Identifies the operation a MetadataFilter node applies. Comparison operators evaluate one metadata key against one or more typed values; And and Or combine child filters.
- MetadataFilterValueKind
Identifies the comparison domain of a MetadataFilterValue. Metadata values are stored as strings; the kind of the filter value decides how the stored string is interpreted before the comparison runs.
- SplitMode
Specifies different splitting modes that can be used during text partitioning operations.
- StorageMode
Specifies the underlying storage mode for a DataSource instance.
Delegates
- Attachment.AttachmentDownloadingProgressCallback
Represents the progress of an attachment download operation.