You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-[In a Haystack Pipeline](#in-a-haystack-pipeline)
18
28
19
-
Component for the Haystack (2.x) LLM framework to easily convert files and directories into Documents using the Unstructured API.
20
29
21
-
**[Unstructured](https://unstructured-io.github.io/unstructured/index.html)** 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. See [supported file types](https://docs.unstructured.io/api-reference/api-services/overview#supported-file-types).
30
+
31
+
## Overview
32
+
Component for the Haystack (2.x) LLM framework to convert files and directories into Documents using the Unstructured API.
33
+
34
+
**[Unstructured](https://unstructured-io.github.io/unstructured/index.html)** provides ETL tools for LLMs, extracting text and other information from various file formats. See [supported file types](https://docs.unstructured.io/api-reference/api-services/overview#supported-file-types) for more details.
22
35
23
36
## Installation
37
+
To install the [Unstructured File Converter](https://docs.haystack.deepset.ai/docs/unstructuredfileconverter), run:
24
38
25
39
```bash
26
40
pip install unstructured-fileconverter-haystack
27
41
```
28
42
29
-
### Hosted API
30
-
If you plan to use the hosted version of the Unstructured API, you just need the **(free) Unstructured API key**. You can get it by signing up [here](https://unstructured.io/api-key-free).
43
+
## Usage
44
+
45
+
### Connecting to the Unstructured API
46
+
#### Hosted API
47
+
48
+
The Unstructured API is available in both free and paid versions: Unstructured Serverless API or Free Unstructured API.
31
49
32
-
### Local API (Docker)
33
-
If you want to run your own local instance of the Unstructured API, you need Docker and you can find instructions [here](https://unstructured-io.github.io/unstructured/api.html#using-docker-images).
50
+
For the Free Unstructured API, the API URL is `https://api.unstructured.io/general/v0/general`. For the Unstructured Serverless API, find your unique API URL in your Unstructured account.
34
51
35
-
In short, this should work:
52
+
Note that the API keys for free and paid versions are not interchangeable.
53
+
54
+
Set the Unstructured API key as an environment variable:
0 commit comments