unstructured-fileconverter-haystack 0.0.4

Haystack 2.x component to convert files into Documents using the Unstructured API

Unstructured FileConverter for Haystack

Component for the Haystack (2.x) LLM framework to easily convert files and directories into Documents using the Unstructured API.

Unstructured provides a series of tools to do ETL for LLMs. This component calls the Unstructured API that simply extracts text and other information from a vast range of file formats. Supported file types.

Haystack is an orchestration framework to build customizable, production-ready LLM applications. Once your files are converted into Documents, you can start building RAG, question answering, semantic search applications and more.

• Installation
• Usage
• Configuration

Installation

pip install unstructured-fileconverter-haystack

Hosted API

If you plan to use the hosted version of the Unstructured API, you just need the (free) Unsctructured API key. You can get it by signing up here.

Local API (Docker)

If you want to run your own local instance of the Unstructured API, you need Docker and you can find instructions here.

In short, this should work:

docker run -p 8000:8000 -d --rm --name unstructured-api quay.io/unstructured-io/unstructured-api:latest --port 8000 --host 0.0.0.0

Usage

In isolation

import os
from unstructured_fileconverter_haystack import UnstructuredFileConverter

os.environ["UNSTRUCTURED_API_KEY"] = "YOUR-API-KEY"

converter = UnstructuredFileConverter()

documents = converter.run(paths = ["a/file/path.pdf", "a/directory/path"])["documents"]
    

In a Haystack Pipeline

import os
from haystack.preview import Pipeline
from haystack.preview.components.writers import DocumentWriter
from haystack.preview.document_stores import MemoryDocumentStore
from unstructured_fileconverter_haystack import UnstructuredFileConverter

os.environ["UNSTRUCTURED_API_KEY"] = "YOUR-API-KEY"

document_store = MemoryDocumentStore()

indexing = Pipeline()
indexing.add_component("converter", UnstructuredFileConverter())
indexing.add_component("writer", DocumentWriter(document_store))
indexing.connect("converter", "writer")

indexing.run({"converter": {"paths": ["a/file/path.pdf", "a/directory/path"]}})

Configuration

Initialization parameters

• api_url: URL of the Unstructured API. Defaults to the hosted version. If you run the API locally, you should specify this parameter.
• api_key: API key for the Unstructured API (https://unstructured.io/#get-api-key). If you run the API locally, it is not needed. If you use the hosted version, it defaults to the environment variable UNSTRUCTURED_API_KEY.
• document_creation_mode: How to create Haystack Documents from the elements returned by Unstructured.
  • "one-doc-per-file": One Haystack Document per file. All elements are concatenated into one text field.
  • "one-doc-per-page": One Haystack Document per page. All elements on a page are concatenated into one text field.
  • "one-doc-per-element": One Haystack Document per element. Each element is converted to a Haystack Document
  • separator: Separator between elements when concatenating them into one text field.
• unstructured_kwargs: Additional keyword arguments that are passed to the Unstructured API. They can be helpful to improve or speed up the conversion. See https://unstructured-io.github.io/unstructured/api.html#parameters.

run method

The method run just expects a list of paths (files or directories) in the paths parameter.

If paths contains a directory, all files in the first level of the directory are converted. Subdirectories are ignored.