MDocument

MDocument クラスは、RAG アプリケーション向けにドキュメントを処理します。主なメソッドは .chunk() と .extractMetadata() です。

コンストラクター

docs:

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

テキスト内容と任意のメタデータを含むドキュメントチャンクの配列

type:

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

ドキュメント内容の種類

静的メソッド

fromText()

プレーンテキストの内容からドキュメントを作成します。

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

fromHTML()

HTML の内容からドキュメントを作成します。

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

fromMarkdown()

Markdown の内容からドキュメントを作成します。

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

fromJSON()

JSON の内容からドキュメントを作成します。

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

インスタンスメソッド

chunk()

ドキュメントをチャンクに分割し、必要に応じてメタデータを抽出します。

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

オプションの詳細は、chunk() リファレンスを参照してください。

getDocs()

処理済みドキュメントチャンクの配列を返します。

getDocs(): Chunk[]

getText()

チャンクから取得したテキスト文字列の配列を返します。

getText(): string[]

getMetadata()

チャンクから取得したメタデータオブジェクトの配列を返します。

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

extractMetadata()

指定した extractor を使用してメタデータを抽出します。詳細は、ExtractParams リファレンスを参照してください。

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

使用例

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