Skip to content

Commit 0bcd730

Browse files
Added adaptor details to README. Moved assets folder to docs/assets (#162)
Co-authored-by: Hari John Kuriakose <hari@zipstack.com>
1 parent e338789 commit 0bcd730

37 files changed

Lines changed: 70 additions & 4 deletions

README.md

Lines changed: 70 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div align="center">
2-
<img src="assets/unstract_u_logo.png" style="height: 120px">
2+
<img src="docs/assets/unstract_u_logo.png" style="height: 120px">
33

44
# Unstract
55

@@ -11,7 +11,7 @@
1111

1212
While co-pilots enable machine-to-human automation, with Unstract, you can go beyond co-pilots by enabling machine-to-machine automation. You can launch APIs that take in complex documents and return structured JSON all with a simple no-code approach. You can also launch unstructured data ETL Pipelines that can read complex documents from a variety of cloud file / object storage systems and write structured data into popular data warehouses and databases.
1313

14-
![img Prompt Studio](assets/prompt_studio.png)
14+
![img Prompt Studio](docs/assets/prompt_studio.png)
1515

1616
## 🧘‍♀️ Three step nirvana
1717

@@ -21,22 +21,88 @@ Automate critical business processes that involve complex documents with a human
2121
🌟 **Step 2**: Configure Prompt Studio project as API deployment or configure input source and output destination for ETL Pipeline<br>
2222
🌟 **Step 3**: Deploy Workflows as unstructured data APIs or unstructured data ETL Pipelines!
2323

24-
![img Using Unstract](assets/Using_Unstract.png)
24+
![img Using Unstract](docs/assets/Using_Unstract.png)
2525

2626
## 🚀 Getting started
2727

28-
The easiest way to get started is with Docker. Clone this repo and do the following:
28+
The easiest way to get started is with Docker. Either download a release or clone this repo and do the following:
2929

3030
`./run-platform.sh`<br>
3131
✅ Now visit [http://frontend.unstract.localhost](http://frontend.unstract.localhost) in your browser <br>
3232
✅ Use user name and password `unstract` to login
3333

3434
That's all there is to it!
3535

36+
Another really quick way to experience Unstract is by signing up for our [hosted version](https://us-central-1.gcp.unstract.com/).
37+
3638
## ⏩ Quick Start Guide
3739

3840
Unstract comes well documented. You can get introduced to the [basics of Unstract](https://docs.unstract.com/), and [learn how to connect](https://docs.unstract.com/unstract_platform/setup_accounts/whats_needed) various systems like LLMs, Vector Databases, Embedding Models and Text Extractors to it. The easiest way to wet your feet is to go through our [Quick Start Guide](https://docs.unstract.com/unstract_platform/quick_start) where you actually get to do some prompt engineering in Prompt Studio and launch an API to structure varied credit card statements!
3941

42+
## 🤝 Ecosystem support
43+
44+
### LLM Providers
45+
|| Provider | Status |
46+
|---|---|---|
47+
|<img src="docs/assets/3rd_party/openai.png" width="32"/>| OpenAI | ✅ Working |
48+
|<img src="docs/assets/3rd_party/vertex_ai.png" width="32"/>| Google VertexAI, Gemini Pro | ✅ Working |
49+
|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure OpenAI | ✅ Working |
50+
|<img src="docs/assets/3rd_party/palm.png" width="32"/>| Google PaLM | ✅ Working |
51+
|<img src="docs/assets/3rd_party/anyscale.png" width="32"/>| Anyscale | ✅ Working |
52+
|<img src="docs/assets/3rd_party/replicate.png" width="32"/>| Replicate | 🗓️ Coming soon! |
53+
|<img src="docs/assets/3rd_party/anthropic.png" width="32"/>| Anthropic | 🗓️ Coming soon! |
54+
|<img src="docs/assets/3rd_party/mistral_ai.png" width="32"/>| Mistral AI | 🗓️ Coming soon! |
55+
56+
### Vector Databases
57+
|| Provider | Status |
58+
|---|---|---|
59+
|<img src="docs/assets/3rd_party/qdrant.png" width="32"/>| Qdrant | ✅ Working |
60+
|<img src="docs/assets/3rd_party/postgres.png" width="32"/>| PostgreSQL | ✅ Working |
61+
|<img src="docs/assets/3rd_party/supabase.png" width="32"/>| Supabase | 🗓️ Coming soon! |
62+
|<img src="docs/assets/3rd_party/milvus.png" width="32"/>| Milvus | 🗓️ Coming soon! |
63+
|<img src="docs/assets/3rd_party/weaviate.png" width="32"/>| Weaviate | 🗓️ Coming soon! |
64+
|<img src="docs/assets/3rd_party/pinecone.png" width="32"/>| Pinecone | 🗓️ Coming soon! |
65+
66+
### Embeddings
67+
|| Provider | Status |
68+
|---|---|---|
69+
|<img src="docs/assets/3rd_party/openai.png" width="32"/>| OpenAI | ✅ Working |
70+
|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure OpenAI | ✅ Working |
71+
|<img src="docs/assets/3rd_party/palm.png" width="32"/>| Google PaLM | ✅ Working |
72+
|<img src="docs/assets/3rd_party/qdrant.png" width="32"/>| Qdrant | ✅ Working |
73+
|<img src="docs/assets/3rd_party/huggingface.png" width="32"/>| Huggingface | 🗓️ Coming soon! |
74+
75+
### Text Extractors
76+
|| Provider | Status |
77+
|---|---|---|
78+
|<img src="docs/assets/unstract_u_logo.png" width="32"/>| Unstract LLMWhisperer | ✅ Working |
79+
|<img src="docs/assets/3rd_party/unstructured_io.png" width="32"/>| Unstructured.io Community | ✅ Working |
80+
|<img src="docs/assets/3rd_party/unstructured_io.png" width="32"/>| Unstructured.io Enterprise | ✅ Working |
81+
|<img src="docs/assets/3rd_party/llamaindex.png" width="32"/>| LlamaIndex Parse | 🗓️ Coming soon! |
82+
83+
### ETL Sources
84+
|| Provider | Status |
85+
|---|---|---|
86+
|<img src="docs/assets/3rd_party/s3.png" width="32"/>| AWS S3 | ✅ Working |
87+
|<img src="docs/assets/3rd_party/minio.png" width="32"/>| Minio | ✅ Working |
88+
|<img src="docs/assets/3rd_party/dropbox.png" width="32"/>| Dropbox | ✅ Working |
89+
|<img src="docs/assets/3rd_party/google_drive.png" width="32"/>| Google Drive | ✅ Working |
90+
|<img src="docs/assets/3rd_party/box.png" width="32"/>| Box | 🗓️ Coming soon! |
91+
|<img src="docs/assets/3rd_party/gcp.png" width="32"/>| Google Cloud Storage | 🗓️ Coming soon! |
92+
|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure Cloud Storage | 🗓️ Coming soon! |
93+
|<img src="docs/assets/3rd_party/http.png" width="32"/>| HTTP/HTTPS | 🗓️ Coming soon! |
94+
95+
### ETL Destinations
96+
|| Provider | Status |
97+
|---|---|---|
98+
|<img src="docs/assets/3rd_party/snowflake.png" width="32"/>| Snowflake | ✅ Working |
99+
|<img src="docs/assets/3rd_party/amazon_redshift.png" width="32"/>| Amazon Redshift | ✅ Working |
100+
|<img src="docs/assets/3rd_party/google_bigquery.png" width="32"/>| Google Bigquery | ✅ Working |
101+
|<img src="docs/assets/3rd_party/postgres.png" width="32"/>| PostgreSQL | ✅ Working |
102+
|<img src="docs/assets/3rd_party/mysql.png" width="32"/>| MySQL | 🗓️ Coming soon! |
103+
|<img src="docs/assets/3rd_party/mariadb.png" width="32"/>| MariaDB | 🗓️ Coming soon! |
104+
|<img src="docs/assets/3rd_party/ms_sql.png" width="32"/>| Microsoft SQL Server | 🗓️ Coming soon! |
105+
40106
## 🙌 Contributing
41107

42108
Contributions are welcome! Please read [CONTRIBUTE.md](CONTRIBUTE.md) for further details on setting up the development environment, etc. It also points you to other detailed documents as needed.
6.45 KB
Loading
42.3 KB
Loading

docs/assets/3rd_party/anyscale.png

2.97 KB
Loading
288 KB
Loading

docs/assets/3rd_party/box.png

5.6 KB
Loading

docs/assets/3rd_party/cohere.png

17.5 KB
Loading

docs/assets/3rd_party/dropbox.png

24.5 KB
Loading

docs/assets/3rd_party/gcp.png

92 KB
Loading

docs/assets/3rd_party/google.png

24 KB
Loading

0 commit comments

Comments
 (0)