langchain_text_splitters.base.TokenTextSplitter

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

使用模型分词器分割文本。

创建一个新的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)

通过分割文档来转换文档序列。
参数

  • encoding_name (str) –

  • model_name (Optional[str]) –

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

  • disallowed_special (Union[Literal['all'], Collection[str]]) –

  • kwargs (Any) –

__init__(encoding_name: str = 'gpt2', model_name: Optional[str] = None, allowed_special: Union[ Literal['all'] , typing.AbstractSet[str]], disallowed_special: Union[Literal['all'] , typing.Collection[str]], **kwargs: Any) → None[source]

创建一个新的TextSplitter。

参数

  • encoding_name (str) –

  • model_name (Optional[str]) –

  • allowed_special (Union[Literal['all'], ~typing.AbstractSet[str]]) –

  • disallowed_special (Union[Literal['all'], ~typing.Collection[str]]) –

  • kwargs (Any) –

返回类型

None

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

异步转换文档列表。

参数

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

  • kwargs (Any) –

返回值

转换后的文档序列。

返回类型

Sequence[Document]

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

从文本列表创建文档。

参数

  • texts (List[str]) –

  • metadatas (Optional[List[dict]]) –

返回类型

List[Document]

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

使用HuggingFace分词器进行计数的文本分割器。

参数

  • tokenizer (Any) –

  • kwargs (Any) –

返回类型

TextSplitter

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

使用tiktoken编码器进行计数的文本分割器。

参数

  • encoding_name (str) –

  • model_name (Optional[str]) –

  • allowed_special (Union[Literal['all'], ~typing.AbstractSet[str]]) –

  • disallowed_special (Union[Literal['all'], ~typing.Collection[str]]) –

  • kwargs (Any) –

返回类型

TS

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

分割文档。

参数

documents (Iterable[Document]) –

返回类型

List[Document]

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

将文本分割成多个组件。

参数

text (str) –

返回类型

List[str]

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

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

参数

  • documents (Sequence[Document]) –

  • kwargs (Any) –

返回类型

Sequence[Document]

使用 TokenTextSplitter 的示例