Skip to content

LLM-Driven Extraction of Unstructured Data — Built for API Deployments & ETL Pipeline Workflows

Added adaptor details to README. Moved assets folder to docs/assets (#162)

Shuveb Hussain0bcd73007a6b
diff --git a/README.md b/README.md
index d65fabceb..12f473d64 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
<div align="center">
-<img src="assets/unstract_u_logo.png" style="height: 120px">
+<img src="docs/assets/unstract_u_logo.png" style="height: 120px">
# Unstract
@@ -11,7 +11,7 @@
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.
-![img Prompt Studio](assets/prompt_studio.png)
+![img Prompt Studio](docs/assets/prompt_studio.png)
## 🧘‍♀️ Three step nirvana
@@ -21,11 +21,11 @@ Automate critical business processes that involve complex documents with a human
🌟 **Step 2**: Configure Prompt Studio project as API deployment or configure input source and output destination for ETL Pipeline<br>
🌟 **Step 3**: Deploy Workflows as unstructured data APIs or unstructured data ETL Pipelines!
-![img Using Unstract](assets/Using_Unstract.png)
+![img Using Unstract](docs/assets/Using_Unstract.png)
## 🚀 Getting started
-The easiest way to get started is with Docker. Clone this repo and do the following:
+The easiest way to get started is with Docker. Either download a release or clone this repo and do the following:
✅ `./run-platform.sh`<br>
✅ Now visit [http://frontend.unstract.localhost](http://frontend.unstract.localhost) in your browser <br>
@@ -33,10 +33,76 @@ The easiest way to get started is with Docker. Clone this repo and do the follow
That's all there is to it!
+Another really quick way to experience Unstract is by signing up for our [hosted version](https://us-central-1.gcp.unstract.com/).
+
## ⏩ Quick Start Guide
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!
+## 🤝 Ecosystem support
+
+### LLM Providers
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/3rd_party/openai.png" width="32"/>| OpenAI | ✅ Working |
+|<img src="docs/assets/3rd_party/vertex_ai.png" width="32"/>| Google VertexAI, Gemini Pro | ✅ Working |
+|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure OpenAI | ✅ Working |
+|<img src="docs/assets/3rd_party/palm.png" width="32"/>| Google PaLM | ✅ Working |
+|<img src="docs/assets/3rd_party/anyscale.png" width="32"/>| Anyscale | ✅ Working |
+|<img src="docs/assets/3rd_party/replicate.png" width="32"/>| Replicate | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/anthropic.png" width="32"/>| Anthropic | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/mistral_ai.png" width="32"/>| Mistral AI | 🗓️ Coming soon! |
+
+### Vector Databases
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/3rd_party/qdrant.png" width="32"/>| Qdrant | ✅ Working |
+|<img src="docs/assets/3rd_party/postgres.png" width="32"/>| PostgreSQL | ✅ Working |
+|<img src="docs/assets/3rd_party/supabase.png" width="32"/>| Supabase | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/milvus.png" width="32"/>| Milvus | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/weaviate.png" width="32"/>| Weaviate | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/pinecone.png" width="32"/>| Pinecone | 🗓️ Coming soon! |
+
+### Embeddings
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/3rd_party/openai.png" width="32"/>| OpenAI | ✅ Working |
+|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure OpenAI | ✅ Working |
+|<img src="docs/assets/3rd_party/palm.png" width="32"/>| Google PaLM | ✅ Working |
+|<img src="docs/assets/3rd_party/qdrant.png" width="32"/>| Qdrant | ✅ Working |
+|<img src="docs/assets/3rd_party/huggingface.png" width="32"/>| Huggingface | 🗓️ Coming soon! |
+
+### Text Extractors
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/unstract_u_logo.png" width="32"/>| Unstract LLMWhisperer | ✅ Working |
+|<img src="docs/assets/3rd_party/unstructured_io.png" width="32"/>| Unstructured.io Community | ✅ Working |
+|<img src="docs/assets/3rd_party/unstructured_io.png" width="32"/>| Unstructured.io Enterprise | ✅ Working |
+|<img src="docs/assets/3rd_party/llamaindex.png" width="32"/>| LlamaIndex Parse | 🗓️ Coming soon! |
+
+### ETL Sources
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/3rd_party/s3.png" width="32"/>| AWS S3 | ✅ Working |
+|<img src="docs/assets/3rd_party/minio.png" width="32"/>| Minio | ✅ Working |
+|<img src="docs/assets/3rd_party/dropbox.png" width="32"/>| Dropbox | ✅ Working |
+|<img src="docs/assets/3rd_party/google_drive.png" width="32"/>| Google Drive | ✅ Working |
+|<img src="docs/assets/3rd_party/box.png" width="32"/>| Box | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/gcp.png" width="32"/>| Google Cloud Storage | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/azure_openai.png" width="32"/>| Azure Cloud Storage | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/http.png" width="32"/>| HTTP/HTTPS | 🗓️ Coming soon! |
+
+### ETL Destinations
+|| Provider | Status |
+|---|---|---|
+|<img src="docs/assets/3rd_party/snowflake.png" width="32"/>| Snowflake | ✅ Working |
+|<img src="docs/assets/3rd_party/amazon_redshift.png" width="32"/>| Amazon Redshift | ✅ Working |
+|<img src="docs/assets/3rd_party/google_bigquery.png" width="32"/>| Google Bigquery | ✅ Working |
+|<img src="docs/assets/3rd_party/postgres.png" width="32"/>| PostgreSQL | ✅ Working |
+|<img src="docs/assets/3rd_party/mysql.png" width="32"/>| MySQL | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/mariadb.png" width="32"/>| MariaDB | 🗓️ Coming soon! |
+|<img src="docs/assets/3rd_party/ms_sql.png" width="32"/>| Microsoft SQL Server | 🗓️ Coming soon! |
+
## 🙌 Contributing
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.
diff --git a/docs/assets/3rd_party/amazon_redshift.png b/docs/assets/3rd_party/amazon_redshift.png
new file mode 100644
index 000000000..51ac003c7
Binary files /dev/null and b/docs/assets/3rd_party/amazon_redshift.png differ
diff --git a/docs/assets/3rd_party/anthropic.png b/docs/assets/3rd_party/anthropic.png
new file mode 100644
index 000000000..ebeda3877
Binary files /dev/null and b/docs/assets/3rd_party/anthropic.png differ
diff --git a/docs/assets/3rd_party/anyscale.png b/docs/assets/3rd_party/anyscale.png
new file mode 100644
index 000000000..8cba20322
Binary files /dev/null and b/docs/assets/3rd_party/anyscale.png differ
diff --git a/docs/assets/3rd_party/azure_openai.png b/docs/assets/3rd_party/azure_openai.png
new file mode 100644
index 000000000..7c750318d
Binary files /dev/null and b/docs/assets/3rd_party/azure_openai.png differ
diff --git a/docs/assets/3rd_party/box.png b/docs/assets/3rd_party/box.png
new file mode 100644
index 000000000..c94c3b38d
Binary files /dev/null and b/docs/assets/3rd_party/box.png differ
diff --git a/docs/assets/3rd_party/cohere.png b/docs/assets/3rd_party/cohere.png
new file mode 100644
index 000000000..4b7b29768
Binary files /dev/null and b/docs/assets/3rd_party/cohere.png differ
diff --git a/docs/assets/3rd_party/dropbox.png b/docs/assets/3rd_party/dropbox.png
new file mode 100644
index 000000000..1ab04552d
Binary files /dev/null and b/docs/assets/3rd_party/dropbox.png differ
diff --git a/docs/assets/3rd_party/gcp.png b/docs/assets/3rd_party/gcp.png
new file mode 100644
index 000000000..3f88a2a27
Binary files /dev/null and b/docs/assets/3rd_party/gcp.png differ
diff --git a/docs/assets/3rd_party/google.png b/docs/assets/3rd_party/google.png
new file mode 100644
index 000000000..2b85ade18
Binary files /dev/null and b/docs/assets/3rd_party/google.png differ
diff --git a/docs/assets/3rd_party/google_bigquery.png b/docs/assets/3rd_party/google_bigquery.png
new file mode 100644
index 000000000..037fae952
Binary files /dev/null and b/docs/assets/3rd_party/google_bigquery.png differ
diff --git a/docs/assets/3rd_party/google_drive.png b/docs/assets/3rd_party/google_drive.png
new file mode 100644
index 000000000..aa64a40c7
Binary files /dev/null and b/docs/assets/3rd_party/google_drive.png differ
diff --git a/docs/assets/3rd_party/http.png b/docs/assets/3rd_party/http.png
new file mode 100644
index 000000000..83b931834
Binary files /dev/null and b/docs/assets/3rd_party/http.png differ
diff --git a/docs/assets/3rd_party/huggingface.png b/docs/assets/3rd_party/huggingface.png
new file mode 100644
index 000000000..6740fec74
Binary files /dev/null and b/docs/assets/3rd_party/huggingface.png differ
diff --git a/docs/assets/3rd_party/llamaindex.png b/docs/assets/3rd_party/llamaindex.png
new file mode 100644
index 000000000..54cd1cd94
Binary files /dev/null and b/docs/assets/3rd_party/llamaindex.png differ
diff --git a/docs/assets/3rd_party/llm_whisperer.png b/docs/assets/3rd_party/llm_whisperer.png
new file mode 100644
index 000000000..aed4e7797
Binary files /dev/null and b/docs/assets/3rd_party/llm_whisperer.png differ
diff --git a/docs/assets/3rd_party/mariadb.png b/docs/assets/3rd_party/mariadb.png
new file mode 100644
index 000000000..b94538def
Binary files /dev/null and b/docs/assets/3rd_party/mariadb.png differ
diff --git a/docs/assets/3rd_party/milvus.png b/docs/assets/3rd_party/milvus.png
new file mode 100644
index 000000000..4d3214c7d
Binary files /dev/null and b/docs/assets/3rd_party/milvus.png differ
diff --git a/docs/assets/3rd_party/minio.png b/docs/assets/3rd_party/minio.png
new file mode 100644
index 000000000..64c15a5de
Binary files /dev/null and b/docs/assets/3rd_party/minio.png differ
diff --git a/docs/assets/3rd_party/mistral_ai.png b/docs/assets/3rd_party/mistral_ai.png
new file mode 100644
index 000000000..65c8e7e36
Binary files /dev/null and b/docs/assets/3rd_party/mistral_ai.png differ
diff --git a/docs/assets/3rd_party/ms_sql.png b/docs/assets/3rd_party/ms_sql.png
new file mode 100644
index 000000000..64279bddb
Binary files /dev/null and b/docs/assets/3rd_party/ms_sql.png differ
diff --git a/docs/assets/3rd_party/mysql.png b/docs/assets/3rd_party/mysql.png
new file mode 100644
index 000000000..a501af1f3
Binary files /dev/null and b/docs/assets/3rd_party/mysql.png differ
diff --git a/docs/assets/3rd_party/openai.png b/docs/assets/3rd_party/openai.png
new file mode 100644
index 000000000..57c3aa7a5
Binary files /dev/null and b/docs/assets/3rd_party/openai.png differ
diff --git a/docs/assets/3rd_party/palm.png b/docs/assets/3rd_party/palm.png
new file mode 100644
index 000000000..5739ec3fb
Binary files /dev/null and b/docs/assets/3rd_party/palm.png differ
diff --git a/docs/assets/3rd_party/pinecone.png b/docs/assets/3rd_party/pinecone.png
new file mode 100644
index 000000000..ac397b4aa
Binary files /dev/null and b/docs/assets/3rd_party/pinecone.png differ
diff --git a/docs/assets/3rd_party/postgres.png b/docs/assets/3rd_party/postgres.png
new file mode 100644
index 000000000..cc7d07fff
Binary files /dev/null and b/docs/assets/3rd_party/postgres.png differ
diff --git a/docs/assets/3rd_party/qdrant.png b/docs/assets/3rd_party/qdrant.png
new file mode 100644
index 000000000..17903e262
Binary files /dev/null and b/docs/assets/3rd_party/qdrant.png differ
diff --git a/docs/assets/3rd_party/replicate.png b/docs/assets/3rd_party/replicate.png
new file mode 100644
index 000000000..525f9993b
Binary files /dev/null and b/docs/assets/3rd_party/replicate.png differ
diff --git a/docs/assets/3rd_party/s3.png b/docs/assets/3rd_party/s3.png
new file mode 100644
index 000000000..8bb301dcc
Binary files /dev/null and b/docs/assets/3rd_party/s3.png differ
diff --git a/docs/assets/3rd_party/snowflake.png b/docs/assets/3rd_party/snowflake.png
new file mode 100644
index 000000000..74b99d8a5
Binary files /dev/null and b/docs/assets/3rd_party/snowflake.png differ
diff --git a/docs/assets/3rd_party/supabase.png b/docs/assets/3rd_party/supabase.png
new file mode 100644
index 000000000..843be59ca
Binary files /dev/null and b/docs/assets/3rd_party/supabase.png differ
diff --git a/docs/assets/3rd_party/unstructured_io.png b/docs/assets/3rd_party/unstructured_io.png
new file mode 100644
index 000000000..a6ec855b6
Binary files /dev/null and b/docs/assets/3rd_party/unstructured_io.png differ
diff --git a/docs/assets/3rd_party/vertex_ai.png b/docs/assets/3rd_party/vertex_ai.png
new file mode 100644
index 000000000..3affe8931
Binary files /dev/null and b/docs/assets/3rd_party/vertex_ai.png differ
diff --git a/docs/assets/3rd_party/weaviate.png b/docs/assets/3rd_party/weaviate.png
new file mode 100644
index 000000000..9c4b489a9
Binary files /dev/null and b/docs/assets/3rd_party/weaviate.png differ
diff --git a/assets/Using_Unstract.png b/docs/assets/Using_Unstract.png
similarity index 100%
rename from assets/Using_Unstract.png
rename to docs/assets/Using_Unstract.png
diff --git a/assets/prompt_studio.png b/docs/assets/prompt_studio.png
similarity index 100%
rename from assets/prompt_studio.png
rename to docs/assets/prompt_studio.png
diff --git a/assets/unstract_u_logo.png b/docs/assets/unstract_u_logo.png
similarity index 100%
rename from assets/unstract_u_logo.png
rename to docs/assets/unstract_u_logo.png