| |
| |
| |
|
|
| from pathlib import Path |
| from typing import Any, Dict, List, Optional, Union |
|
|
| from haystack import Document, component, logging |
| from haystack.components.converters.utils import get_bytestream_from_source, normalize_metadata |
| from haystack.dataclasses import ByteStream |
|
|
| logger = logging.getLogger(__name__) |
|
|
|
|
| @component |
| class TextFileToDocument: |
| """ |
| Converts text files to documents your pipeline can query. |
| |
| By default, it uses UTF-8 encoding when converting files but |
| you can also set custom encoding. |
| It can attach metadata to the resulting documents. |
| |
| ### Usage example |
| |
| ```python |
| from haystack.components.converters.txt import TextFileToDocument |
| |
| converter = TextFileToDocument() |
| results = converter.run(sources=["sample.txt"]) |
| documents = results["documents"] |
| print(documents[0].content) |
| # 'This is the content from the txt file.' |
| ``` |
| """ |
|
|
| def __init__(self, encoding: str = "utf-8"): |
| """ |
| Creates a TextFileToDocument component. |
| |
| :param encoding: |
| The encoding of the text files to convert. |
| If the encoding is specified in the metadata of a source ByteStream, |
| it overrides this value. |
| """ |
| self.encoding = encoding |
|
|
| @component.output_types(documents=List[Document]) |
| def run( |
| self, |
| sources: List[Union[str, Path, ByteStream]], |
| meta: Optional[Union[Dict[str, Any], List[Dict[str, Any]]]] = None, |
| ): |
| """ |
| Converts text files to documents. |
| |
| :param sources: |
| List of HTML file paths or ByteStream objects to convert. |
| :param meta: |
| Optional metadata to attach to the documents. |
| This value can be a list of dictionaries or a single dictionary. |
| If it's a single dictionary, its content is added to the metadata of all produced documents. |
| If it's a list, its length must match the number of sources as they're zipped together. |
| For ByteStream objects, their `meta` is added to the output documents. |
| |
| :returns: |
| A dictionary with the following keys: |
| - `documents`: A list of converted documents. |
| """ |
| documents = [] |
|
|
| meta_list = normalize_metadata(meta, sources_count=len(sources)) |
|
|
| for source, metadata in zip(sources, meta_list): |
| try: |
| bytestream = get_bytestream_from_source(source) |
| except Exception as e: |
| logger.warning("Could not read {source}. Skipping it. Error: {error}", source=source, error=e) |
| continue |
| try: |
| encoding = bytestream.meta.get("encoding", self.encoding) |
| text = bytestream.data.decode(encoding) |
| except Exception as e: |
| logger.warning( |
| "Could not convert file {source}. Skipping it. Error message: {error}", source=source, error=e |
| ) |
| continue |
|
|
| merged_metadata = {**bytestream.meta, **metadata} |
| document = Document(content=text, meta=merged_metadata) |
| documents.append(document) |
|
|
| return {"documents": documents} |
|
|
