TokenTextSplitter#

class langchain_text_splitters.base.TokenTextSplitter(encoding_name: str = 'gpt2', model_name: str | None = None, allowed_special: Literal['all'] | AbstractSet[str] = {}, disallowed_special: Literal['all'] | Collection[str] = 'all', **kwargs: Any)[source]#

使用模型分词器将文本分割为标记。

创建一个新的TextSplitter。

方法

__init__([encoding_name, model_name, ...])

创建一个新的TextSplitter。

atransform_documents(documents, **kwargs)

异步转换文档列表。

create_documents(texts[, metadatas])

从文本列表中创建文档。

from_huggingface_tokenizer(tokenizer, **kwargs)

使用HuggingFace分词器来计算长度的文本分割器。

from_tiktoken_encoder([encoding_name, ...])

使用tiktoken编码器来计算长度的文本分割器。

split_documents(documents)

分割文档。

split_text(text)

根据标记化将输入文本分割成较小的块。

transform_documents(documents, **kwargs)

通过拆分文档来转换文档序列。
Parameters:

  • encoding_name (str)

  • model_name (可选[str])

  • allowed_special (Union[Literal['all'], AbstractSet[str]])

  • disallowed_special (联合[字面量['all'], 集合[str]])

  • kwargs (Any)

__init__(encoding_name: str = 'gpt2', model_name: str | None = None, allowed_special: Literal['all'] | AbstractSet[str] = {}, disallowed_special: Literal['all'] | Collection[str] = 'all', **kwargs: Any) → None[来源]#

创建一个新的TextSplitter。

Parameters:

  • encoding_name (str)

  • model_name (str | None)

  • allowed_special (Literal['all'] | ~typing.AbstractSet[str])

  • disallowed_special (Literal['all'] | ~typing.Collection[str])

  • kwargs (Any)

Return type:

无

async atransform_documents(documents: Sequence[Document], **kwargs: Any) → Sequence[Document]#

异步转换文档列表。

Parameters:

  • documents (Sequence[Document]) – 要转换的文档序列。

  • kwargs (Any)

Returns:

一系列转换后的文档。

Return type:

序列[Document]

create_documents(texts: List[str], metadatas: List[dict] | None = None) → List[Document]#

从文本列表创建文档。

Parameters:

  • 文本 (列表[字符串])

  • metadatas (列表[字典] | 无)

Return type:

列表[文档]

classmethod from_huggingface_tokenizer(tokenizer: Any, **kwargs: Any) → TextSplitter#

使用HuggingFace分词器来计算长度的文本分割器。

Parameters:

  • tokenizer (任意)

  • kwargs (Any)

Return type:

TextSplitter

classmethod from_tiktoken_encoder(encoding_name: str = 'gpt2', model_name: str | None = None, allowed_special: Literal['all'] | AbstractSet[str] = {}, disallowed_special: Literal['all'] | Collection[str] = 'all', **kwargs: Any) → TS#

使用tiktoken编码器来计算长度的文本分割器。

Parameters:

  • encoding_name (str)

  • model_name (str | None)

  • allowed_special (Literal['all'] | ~typing.AbstractSet[str])

  • disallowed_special (Literal['all'] | ~typing.Collection[str])

  • kwargs (Any)

Return type:

TS

split_documents(documents: Iterable[Document]) → List[Document]#

分割文档。

Parameters:

文档 (可迭代[Document])

Return type:

列表[文档]

split_text(text: str) → List[str][source]#

根据标记化将输入文本分割成较小的块。

此方法使用自定义的分词器配置将输入文本编码为令牌，以指定大小的块处理令牌并带有重叠，然后将它们解码回文本块。分割是使用split_text_on_tokens函数执行的。

Parameters:

text (str) – 要分割成较小块的输入文本。

Returns:

文本块的列表，其中每个块都是根据标记化和分块规则从输入文本的一部分派生的。

Return type:

列表[str]

transform_documents(documents: Sequence[Document], **kwargs: Any) → Sequence[Document]#

通过拆分文档序列来转换文档。

Parameters:

  • 文档 (序列[Document])

  • kwargs (Any)

Return type:

序列[文档]

使用 TokenTextSplitter 的示例