diff --git a/README.md b/README.md index d65fabce..12f473d6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- + # 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
🌟 **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`
✅ Now visit [http://frontend.unstract.localhost](http://frontend.unstract.localhost) in your browser
@@ -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 | +|---|---|---| +|| OpenAI | ✅ Working | +|| Google VertexAI, Gemini Pro | ✅ Working | +|| Azure OpenAI | ✅ Working | +|| Google PaLM | ✅ Working | +|| Anyscale | ✅ Working | +|| Replicate | 🗓️ Coming soon! | +|| Anthropic | 🗓️ Coming soon! | +|| Mistral AI | 🗓️ Coming soon! | + +### Vector Databases +|| Provider | Status | +|---|---|---| +|| Qdrant | ✅ Working | +|| PostgreSQL | ✅ Working | +|| Supabase | 🗓️ Coming soon! | +|| Milvus | 🗓️ Coming soon! | +|| Weaviate | 🗓️ Coming soon! | +|| Pinecone | 🗓️ Coming soon! | + +### Embeddings +|| Provider | Status | +|---|---|---| +|| OpenAI | ✅ Working | +|| Azure OpenAI | ✅ Working | +|| Google PaLM | ✅ Working | +|| Qdrant | ✅ Working | +|| Huggingface | 🗓️ Coming soon! | + +### Text Extractors +|| Provider | Status | +|---|---|---| +|| Unstract LLMWhisperer | ✅ Working | +|| Unstructured.io Community | ✅ Working | +|| Unstructured.io Enterprise | ✅ Working | +|| LlamaIndex Parse | 🗓️ Coming soon! | + +### ETL Sources +|| Provider | Status | +|---|---|---| +|| AWS S3 | ✅ Working | +|| Minio | ✅ Working | +|| Dropbox | ✅ Working | +|| Google Drive | ✅ Working | +|| Box | 🗓️ Coming soon! | +|| Google Cloud Storage | 🗓️ Coming soon! | +|| Azure Cloud Storage | 🗓️ Coming soon! | +|| HTTP/HTTPS | 🗓️ Coming soon! | + +### ETL Destinations +|| Provider | Status | +|---|---|---| +|| Snowflake | ✅ Working | +|| Amazon Redshift | ✅ Working | +|| Google Bigquery | ✅ Working | +|| PostgreSQL | ✅ Working | +|| MySQL | 🗓️ Coming soon! | +|| MariaDB | 🗓️ Coming soon! | +|| 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 00000000..51ac003c 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 00000000..ebeda387 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 00000000..8cba2032 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 00000000..7c750318 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 00000000..c94c3b38 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 00000000..4b7b2976 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 00000000..1ab04552 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 00000000..3f88a2a2 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 00000000..2b85ade1 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 00000000..037fae95 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 00000000..aa64a40c 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 00000000..83b93183 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 00000000..6740fec7 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 00000000..54cd1cd9 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 00000000..aed4e779 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 00000000..b94538de 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 00000000..4d3214c7 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 00000000..64c15a5d 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 00000000..65c8e7e3 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 00000000..64279bdd 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 00000000..a501af1f 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 00000000..57c3aa7a 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 00000000..5739ec3f 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 00000000..ac397b4a 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 00000000..cc7d07ff 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 00000000..17903e26 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 00000000..525f9993 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 00000000..8bb301dc 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 00000000..74b99d8a 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 00000000..843be59c 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 00000000..a6ec855b 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 00000000..3affe893 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 00000000..9c4b489a 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