MDocument

La classe MDocument traite les documents destinés aux applications RAG. Ses principales méthodes sont .chunk() et .extractMetadata().

Constructor

docs:

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

Tableau de fragments de document avec leur contenu textuel et des métadonnées facultatives

type:

'text' | 'html' | 'markdown' | 'json' | 'latex'

Type de contenu du document

Méthodes statiques

fromText()

Crée un document à partir de contenu en texte brut.

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

fromHTML()

Crée un document à partir de contenu HTML.

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

fromMarkdown()

Crée un document à partir de contenu Markdown.

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

fromJSON()

Crée un document à partir de contenu JSON.

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

Méthodes d’instance

chunk()

Découpe le document en fragments et extrait facultativement des métadonnées.

async chunk(params?: ChunkParams): Promise<Chunk[]>

Consultez la référence de chunk() pour connaître les options détaillées.

getDocs()

Renvoie un tableau de fragments de document traités.

getDocs(): Chunk[]

getText()

Renvoie un tableau de chaînes de texte provenant des fragments.

getText(): string[]

getMetadata()

Renvoie un tableau d’objets de métadonnées provenant des fragments.

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

extractMetadata()

Extrait des métadonnées à l’aide des extracteurs indiqués. Consultez la référence d’ExtractParams pour plus de détails.

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

Exemples

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()