变换

变换是指接受节点列表作为输入，并返回节点列表的操作。每个实现Transformation基类的组件都有一个同步的__call__()定义和一个异步的acall()定义。

目前，以下组件是Transformation对象：

• TextSplitter
• NodeParser
• MetadataExtractor
• Embeddings模型 (查看我们支持的嵌入列表)

使用模式

虽然变换最好与IngestionPipeline一起使用，但也可以直接使用。

from llama_index.core.node_parser import SentenceSplitter
from llama_index.core.extractors import TitleExtractor

node_parser = SentenceSplitter(chunk_size=512)
extractor = TitleExtractor()

# 直接使用转换
nodes = node_parser(documents)

# 或者在异步中使用转换
nodes = await extractor.acall(nodes)

与索引结合

变换可以传递到索引或全局设置中，并在调用索引的from_documents()或insert()时使用。

from llama_index.core import VectorStoreIndex
from llama_index.core.extractors import (
    TitleExtractor,
    QuestionsAnsweredExtractor,
)
from llama_index.core.ingestion import IngestionPipeline
from llama_index.core.node_parser import TokenTextSplitter

transformations = [
    TokenTextSplitter(chunk_size=512, chunk_overlap=128),
    TitleExtractor(nodes=5),
    QuestionsAnsweredExtractor(questions=3),
]

# 全局
from llama_index.core import Settings

Settings.transformations = [text_splitter, title_extractor, qa_extractor]

# 每个索引
index = VectorStoreIndex.from_documents(
    documents, transformations=transformations
)

自定义变换

您可以通过实现基类来自定义任何变换。

以下自定义变换将删除文本中的任何特殊字符或标点符号。

import re
from llama_index.core import Document
from llama_index.embeddings.openai import OpenAIEmbedding
from llama_index.core.node_parser import SentenceSplitter
from llama_index.core.ingestion import IngestionPipeline
from llama_index.core.schema import TransformComponent


class TextCleaner(TransformComponent):
    def __call__(self, nodes, **kwargs):
        for node in nodes:
            node.text = re.sub(r"[^0-9A-Za-z ]", "", node.text)
        return nodes

然后可以直接使用或在任何IngestionPipeline中使用。

# 在管道中使用
pipeline = IngestionPipeline(
    transformations=[
        SentenceSplitter(chunk_size=25, chunk_overlap=0),
        TextCleaner(),
        OpenAIEmbedding(),
    ],
)

nodes = pipeline.run(documents=[Document.example()])