LlamaIndexTS 文档处理中的常见问题与解决方案

文档对象处理异常分析

在使用LlamaIndexTS进行文档处理时，开发者可能会遇到doc.toJSON is not a function的错误提示。这种情况通常发生在尝试将普通JavaScript对象直接传递给需要Document类型的方法时。

LlamaIndexTS的核心设计理念是使用强类型的Document类来处理文档数据，而不是简单的对象字面量。这种设计确保了文档处理的一致性和可靠性。

正确使用Document类

要解决这个问题，开发者需要正确导入并使用Document类。在最新版本的LlamaIndexTS中，Document类可以通过以下两种方式导入：

// 方式一：从主包导入
import { Document } from "llamaindex";

// 方式二：从核心模块导入
import { Document } from "@llamaindex/core/schema";

创建文档对象时，应该使用Document类的构造函数：

const document = new Document({ 
  text: "这里是文档内容..." 
});

节点文本访问的变化

在文档处理过程中，开发者可能会注意到NodeWithScore<Metadata>["node"]["text"]的类型定义发生了变化。这一变化反映了LlamaIndexTS对多模态支持的增强。

现在文档节点可能包含多种数据类型，而不仅仅是文本。为了安全地访问节点内容，建议采用以下方式：

// 安全访问节点文本内容
if (typeof doc.node.text === "string") {
  const textContent = doc.node.text;
  // 处理文本内容
}

完整文档处理示例

下面是一个完整的文档管理类实现，展示了如何正确使用LlamaIndexTS进行文档的存储、检索和查询：

import { pipeline } from "@huggingface/transformers";
import { Document } from "@llamaindex/core/schema";
import {
  HuggingFaceEmbedding,
  Settings,
  VectorIndexRetriever,
  VectorStoreIndex,
} from "llamaindex";

class DocumentManager {
  private retriever!: VectorIndexRetriever;
  private queryEngine!: any;

  async init(documents: (string | Document)[]): Promise<void> {
    Settings.embedModel = new HuggingFaceEmbedding({});
    
    const index = await VectorStoreIndex.fromDocuments(
      documents.map((doc) => 
        typeof doc === "string" ? new Document({ text: doc }) : doc
      )
    );
    
    this.retriever = index.asRetriever();
    this.queryEngine = await pipeline("question-answering");
  }

  async query(query: string): Promise<any[]> {
    const documents = await this.retriever.retrieve({ query });
    const results = [];
    
    for (const doc of documents) {
      if (typeof doc.node.text === "string") {
        const result = await this.queryEngine(query, doc.node.text);
        results.push(result);
      }
    }
    
    return results;
  }
}

最佳实践建议

1. 始终使用Document类：避免直接使用普通对象，确保文档数据的完整性和一致性。

2. 处理多模态内容：考虑到未来可能支持图像等非文本内容，代码中应对节点内容类型进行检查。

3. 版本兼容性：注意不同版本间的API变化，特别是从0.5.x版本开始的一些重大变更。

4. 错误处理：在访问节点属性时添加类型检查，增强代码的健壮性。

通过遵循这些实践，开发者可以充分利用LlamaIndexTS的强大功能，构建稳定可靠的文档处理应用。