# Copyright (c) "Neo4j"
# Neo4j Sweden AB [https://neo4j.com]
# #
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# #
# https://www.apache.org/licenses/LICENSE-2.0
# #
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import annotations
from abc import abstractmethod
from collections.abc import Iterator
from neo4j_graphrag.components.base import Component
from neo4j_graphrag.components.types import TextChunk, TextChunks
[docs]
class TextSplitter(Component):
"""Interface for a text splitter.
Implementations must override :meth:`iter_chunks`. The default
:meth:`run` implementation collects the chunks into a
:class:`~neo4j_graphrag.components.types.TextChunks` object.
"""
[docs]
@abstractmethod
def iter_chunks(self, text: str) -> Iterator[TextChunk]:
"""Splits a piece of text into chunks, yielding them one at a time.
Args:
text (str): The text to be split.
Returns:
Iterator[TextChunk]: The chunks, in document order.
"""
raise NotImplementedError
[docs]
async def run(self, text: str) -> TextChunks:
"""Splits a piece of text into chunks.
Args:
text (str): The text to be split.
Returns:
TextChunks: A list of chunks.
"""
return TextChunks(chunks=list(self.iter_chunks(text)))