MDocument

The MDocument class processes documents for RAG applications. The main methods are .chunk() and .extractMetadata().

Constructor

docs:

Array<{ text: string, metadata?: Record<string, any> }>

Array of document chunks with their text content and optional metadata

type:

string

Type of document content. Recognized values are 'text', 'html', 'markdown', 'json', and 'latex'.

Static methods

fromText()

Creates a document from plain text content.

static fromText(text: string, metadata?: Record<string, any>): MDocument

fromHTML()

Creates a document from HTML content.

static fromHTML(html: string, metadata?: Record<string, any>): MDocument

fromMarkdown()

Creates a document from Markdown content.

static fromMarkdown(markdown: string, metadata?: Record<string, any>): MDocument

fromJSON()

Creates a document from JSON content.

static fromJSON(json: string, metadata?: Record<string, any>): MDocument

Instance methods

chunk()

Splits document into chunks and optionally extracts metadata.

async chunk(
  params?: ChunkParams,
  options?: { observabilityContext?: ObservabilityContext },
): Promise<Chunk[]>

Pass observabilityContext to attach the chunking and metadata extraction spans to an existing trace.

See chunk() reference for detailed options.

getDocs()

Returns array of processed document chunks.

getDocs(): Chunk[]

getText()

Returns array of text strings from chunks.

getText(): string[]

getMetadata()

Returns array of metadata objects from chunks.

getMetadata(): Record<string, any>[]

extractMetadata()

Extracts metadata using specified extractors. See ExtractParams reference for details.

async extractMetadata(params: ExtractParams): Promise<MDocument>

Examples

import { MDocument } from '@mastra/rag'

// Create document from text
const doc = MDocument.fromText('Your content here')

// Split into chunks with metadata extraction
const chunks = await doc.chunk({
  strategy: 'markdown',
  headers: [
    ['#', 'title'],
    ['##', 'section'],
  ],
  extract: {
    summary: true, // Extract summaries with default settings
    keywords: true, // Extract keywords with default settings
  },
})

// Get processed chunks
const docs = doc.getDocs()
const texts = doc.getText()
const metadata = doc.getMetadata()