Update version to v0.0.72 (#809 )

[Docs] Add docs for Azure OpenAI provider (#804 )
[feature]: Improve pinecone db integration (#806 )
2023-10-16 13:33:36 -07:00 · 2023-10-16 13:31:56 -07:00 · 2023-10-15 02:26:35 -07:00 · 2023-10-15 01:54:07 -07:00 · 2023-10-14 19:16:27 -07:00 · 2023-10-14 19:14:24 -07:00
147 changed files with 5616 additions and 1177 deletions
@@ -1 +1 @@
-OPENAI_API_KEY=
+OPENAI_API_KEY="your-openai-api-key"
@@ -23,10 +23,10 @@ jobs:
        run: |
          curl -sSL https://install.python-poetry.org | python3 -
          echo "$HOME/.local/bin" >> $GITHUB_PATH
-  
+
      - name: Install dependencies
        run: poetry install
-  
+
      - name: Build a binary wheel and a source tarball
        run: poetry build

@@ -37,4 +37,4 @@ jobs:

      - name: Publish distribution 📦 to PyPI
        if: startsWith(github.ref, 'refs/tags')
-        uses: pypa/gh-action-pypi-publish@release/v1
+        uses: pypa/gh-action-pypi-publish@release/v1
@@ -23,6 +23,15 @@ jobs:
      - name: Install dependencies
        run: poetry install --all-extras
      - name: Lint with ruff
-        run: make ci_lint
+        run: make lint
      - name: Test with pytest
-        run: make ci_test
+        run: make test
+      - name: Generate coverage report
+        run: make coverage
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          file: coverage.xml
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
@@ -76,7 +76,7 @@ docs/_build/
 target/

 # Jupyter Notebook
-.ipynb_checkpoints
+*.yaml

 # IPython
 profile_default/
@@ -171,3 +171,6 @@ db
 .idea/

 .DS_Store
+
+notebooks/*.yaml
+.ipynb_checkpoints/
@@ -4,17 +4,23 @@ PIP := $(PYTHON) -m pip
 PROJECT_NAME := embedchain

 # Targets
-.PHONY: install format lint clean test ci_lint ci_test
+.PHONY: install format lint clean test ci_lint ci_test coverage

 install:
 	poetry install

+install_all:
+	poetry install --all-extras
+
 install_es:
 	poetry install --extras elasticsearch

 install_opensearch:
 	poetry install --extras opensearch

+install_milvus:
+	poetry install --extras milvus
+
 shell:
 	poetry shell

@@ -25,17 +31,14 @@ format:
 	$(PYTHON) -m black .
 	$(PYTHON) -m isort .

-lint:
-	$(PYTHON) -m ruff .
-
 clean:
 	rm -rf dist build *.egg-info

-test:
-	$(PYTHON) -m pytest
-
-ci_lint:
+lint:
 	poetry run ruff .

-ci_test:
+test:
 	poetry run pytest
+
+coverage:
+	poetry run pytest --cov=$(PROJECT_NAME) --cov-report=xml
@@ -6,8 +6,9 @@
 [![Twitter](https://img.shields.io/twitter/follow/embedchain)](https://twitter.com/embedchain)
 [![Substack](https://img.shields.io/badge/Substack-%23006f5c.svg?logo=substack)](https://embedchain.substack.com/)
 [![Open in Colab](https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing)
+[![codecov](https://codecov.io/gh/embedchain/embedchain/graph/badge.svg?token=EMRRHZXW1Q)](https://codecov.io/gh/embedchain/embedchain)

-Embedchain is a framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchainjs)
+Embedchain is a Data Platform for LLMs - load, index, retrieve, and sync any unstructured data. Using embedchain, you can easily create LLM powered apps over any data. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchain/tree/main/embedchain-js)

 ## Community

@@ -27,7 +28,7 @@ pip install --upgrade embedchain

 Try out embedchain in your browser:

-[![Open in Colab](https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing)
+[![Open in Colab](https://camo.githubusercontent.com/84f0493939e0c4de4e6dbe113251b4bfb5353e57134ffd9fcab6b8714514d4d1/68747470733a2f2f636f6c61622e72657365617263682e676f6f676c652e636f6d2f6173736574732f636f6c61622d62616467652e737667)](https://colab.research.google.com/drive/17ON1LPonnXAtLaZEebnOktstB_1cJJmh?usp=sharing)

 ## 📖 Documentation

@@ -35,7 +36,7 @@ The documentation for embedchain can be found at [docs.embedchain.ai](https://do

 ## 💻 Usage

-Embedchain empowers you to create chatbot models similar to ChatGPT, using your own evolving dataset.
+Embedchain empowers you to create ChatGPT like apps, on your own dynamic dataset.

 ### Data Types Supported

@@ -45,7 +46,9 @@ Embedchain empowers you to create chatbot models similar to ChatGPT, using your
 * Sitemap
 * Doc file
 * Code documentation website loader
-* Notion
+* Notion and many more.
+
+You can find the full list of data types on [our documentation](https://docs.embedchain.ai/data-sources/csv).

 ### Queries

@@ -62,7 +65,7 @@ elon_bot = App()
 # Embed online resources
 elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
 elon_bot.add("https://www.forbes.com/profile/elon-musk")
-elon_bot.add("https://www.youtube.com/watch?v=MxZpaJK74Y4")
+elon_bot.add("https://www.youtube.com/watch?v=RcYjXbSJBN8")

 # Query the bot
 elon_bot.query("How many companies does Elon Musk run and name those?")
@@ -80,14 +83,18 @@ For more reference, please go through [Development Guide](https://docs.embedchai
  <img src="https://contrib.rocks/image?repo=embedchain/embedchain" />
 </a>

+## Telemetry
+
+We collect anonymous usage metrics to enhance our package's quality and user experience. This includes data like feature usage frequency and system info, but never personal details. The data helps us prioritize improvements and ensure compatibility. If you wish to opt-out, set the `app.config.collect_metrics = False` in the code. We prioritize data security and don't share this data externally.
+
 ## Citation

 If you utilize this repository, please consider citing it with:

 ```
@misc{embedchain,
-  author = {Taranjeet Singh},
-  title = {Embedchain: Framework to easily create LLM powered bots over any dataset},
+  author = {Taranjeet Singh, Deshraj Yadav},
+  title = {Embedchain: Data platform for LLMs - load, index, retrieve, and sync any unstructured data},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
@@ -0,0 +1,8 @@
+llm:
+  provider: anthropic
+  model: 'claude-instant-1'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
@@ -0,0 +1,19 @@
+app:
+  config:
+    id: azure-openai-app
+
+llm:
+  provider: azure_openai
+  model: gpt-35-turbo
+  config:
+    deployment_name: your_llm_deployment_name
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: azure_openai
+  config:
+    model: text-embedding-ada-002
+    deployment_name: you_embedding_model_deployment_name
@@ -0,0 +1,26 @@
+app:
+  config:
+    id: 'my-app'
+    collection_name: 'my-app'
+
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-app'
+    dir: db
+    allow_reset: true
+
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
+    deployment_name: null
@@ -0,0 +1,7 @@
+llm:
+  provider: cohere
+  model: large
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
@@ -0,0 +1,35 @@
+app:
+  config:
+    id: 'full-stack-app'
+
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+    template: |
+      Use the following pieces of context to answer the query at the end.
+      If you don't know the answer, just say that you don't know, don't try to make up an answer.
+
+      $context
+
+      Query: $query
+
+      Helpful Answer:
+    system_prompt: |
+      Act as William Shakespeare. Answer the following questions in the style of William Shakespeare.
+
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-collection-name'
+    dir: db
+    allow_reset: true
+
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
@@ -0,0 +1,13 @@
+llm:
+  provider: gpt4all
+  model: 'orca-mini-3b.ggmlv3.q4_0.bin'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: gpt4all
+  config:
+    model: 'all-MiniLM-L6-v2'
@@ -0,0 +1,8 @@
+llm:
+  provider: huggingface
+  model: 'google/flan-t5-xxl'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 0.5
+    stream: false
@@ -0,0 +1,7 @@
+llm:
+  provider: jina
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
@@ -0,0 +1,8 @@
+llm:
+  provider: llama2
+  model: 'a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 0.5
+    stream: false
@@ -0,0 +1,33 @@
+app:
+  config:
+    id: 'my-app'
+    log_level: 'WARN'
+    collect_metrics: true
+    collection_name: 'my-app'
+
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+vectordb:
+  provider: opensearch
+  config:
+    opensearch_url: 'https://localhost:9200'
+    http_auth:
+      - admin
+      - admin
+    vector_dimension: 1536
+    collection_name: 'my-app'
+    use_ssl: false
+    verify_certs: false
+
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
+    deployment_name: null
@@ -0,0 +1,27 @@
+app:
+  config:
+    id: 'open-source-app'
+    collection_name: 'open-source-app'
+    collect_metrics: false
+
+llm:
+  provider: gpt4all
+  model: 'orca-mini-3b.ggmlv3.q4_0.bin'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'open-source-app'
+    dir: db
+    allow_reset: true
+
+embedder:
+  provider: gpt4all
+  config:
+    model: 'all-MiniLM-L6-v2'
+    deployment_name: null
@@ -0,0 +1,6 @@
+vectordb:
+  provider: pinecone
+  config:
+    metric: cosine
+    vector_dimension: 1536
+    collection_name: my-pinecone-index
@@ -0,0 +1,6 @@
+llm:
+  provider: vertexai
+  model: 'chat-bison'
+  config:
+    temperature: 0.5
+    top_p: 0.5
@@ -0,0 +1,10 @@
+install:
+	npm i -g mintlify
+
+run_local:
+	mintlify dev
+
+troubleshoot:
+	mintlify install
+
+.PHONY: install run_local troubleshoot
@@ -0,0 +1,11 @@
+<CardGroup cols={3}>
+  <Card title="Slack" icon="slack" href="https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw" color="#4A154B">
+    Join our slack community
+  </Card>
+  <Card title="Discord" icon="discord" href="https://discord.gg/6PzXDgEjG5" color="#7289DA">
+    Join our discord community
+  </Card>
+  <Card title="Schedule a call" icon="calendar" href="https://cal.com/taranjeetio/ec">
+  Schedule a call with Embedchain founder
+  </Card>
+</CardGroup>
@@ -0,0 +1,18 @@
+<Tip>
+If you can't find the specific data source, please feel free to request through one of the following channels and help us prioritize.
+
+<CardGroup cols={2}>
+  <Card title="Slack" icon="slack" href="https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw" color="#4A154B">
+    Let us know on our slack community
+  </Card>
+  <Card title="Discord" icon="discord" href="https://discord.gg/6PzXDgEjG5" color="#7289DA">
+    Let us know on discord community
+  </Card>
+  <Card title="GitHub" icon="github" href="https://github.com/embedchain/embedchain/issues/new?assignees=&labels=&projects=&template=feature_request.yml" color="#181717">
+  Open an issue on our GitHub
+  </Card>
+  <Card title="Schedule a call" icon="calendar" href="https://cal.com/taranjeetio/ec">
+  Schedule a call with Embedchain founder
+  </Card>
+</CardGroup>
+</Tip>
@@ -0,0 +1,18 @@
+<Tip>
+If you can't find the specific LLM you need, no need to fret. We're continuously expanding our support for additional LLMs, and you can help us prioritize by opening an issue on our GitHub or simply reaching out to us on our Slack or Discord community.
+
+<CardGroup cols={2}>
+  <Card title="Slack" icon="slack" href="https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw" color="#4A154B">
+    Let us know on our slack community
+  </Card>
+  <Card title="Discord" icon="discord" href="https://discord.gg/6PzXDgEjG5" color="#7289DA">
+    Let us know on discord community
+  </Card>
+  <Card title="GitHub" icon="github" href="https://github.com/embedchain/embedchain/issues/new?assignees=&labels=&projects=&template=feature_request.yml" color="#181717">
+  Open an issue on our GitHub
+  </Card>
+  <Card title="Schedule a call" icon="calendar" href="https://cal.com/taranjeetio/ec">
+  Schedule a call with Embedchain founder
+  </Card>
+</CardGroup>
+</Tip>
@@ -0,0 +1,18 @@
+<Tip>
+If you can't find the specific vector database, please feel free to request through one of the following channels and help us prioritize.
+
+<CardGroup cols={2}>
+  <Card title="Slack" icon="slack" href="https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw" color="#4A154B">
+    Let us know on our slack community
+  </Card>
+  <Card title="Discord" icon="discord" href="https://discord.gg/6PzXDgEjG5" color="#7289DA">
+    Let us know on discord community
+  </Card>
+  <Card title="GitHub" icon="github" href="https://github.com/embedchain/embedchain/issues/new?assignees=&labels=&projects=&template=feature_request.yml" color="#181717">
+  Open an issue on our GitHub
+  </Card>
+  <Card title="Schedule a call" icon="calendar" href="https://cal.com/taranjeetio/ec">
+  Schedule a call with Embedchain founder
+  </Card>
+</CardGroup>
+</Tip>
@@ -1,25 +0,0 @@
---
-title: '➕ Adding Data'
---
-
-## Add Dataset
-
- This step assumes that you have already created an `app` instance by either using `App`, `OpenSourceApp` or `CustomApp`. We are calling our app instance as `naval_chat_bot` 🤖
-
- Now use `.add` method to add any dataset.
-
-```python
-# naval_chat_bot = App() or
-# naval_chat_bot = OpenSourceApp()
-
-# Embed Online Resources
-naval_chat_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44")
-naval_chat_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf")
-naval_chat_bot.add("https://nav.al/feedback")
-naval_chat_bot.add("https://nav.al/agi")
-
-# Embed Local Resources
-naval_chat_bot.add(("Who is Naval Ravikant?", "Naval Ravikant is an Indian-American entrepreneur and investor."))
-```
-
-The possible formats to add data can be found on the [Supported Data Formats](/advanced/data_types) page.
@@ -1,140 +0,0 @@
---
-title: '📱 App types'
---
-
-## App Types
-
-We have three types of App.
-
-### App
-
-```python
-from embedchain import App
-app = App()
-```
-
- `App` uses OpenAI's model, so these are paid models. 💸 You will be charged for embedding model usage and LLM usage.
- `App` uses OpenAI's embedding model to create embeddings for chunks and ChatGPT API as LLM to get answer given the relevant docs. Make sure that you have an OpenAI account and an API key. If you don't have an API key, you can create one by visiting [this link](https://platform.openai.com/account/api-keys).
- `App` is opinionated. It uses the best embedding model and LLM on the market.
- Once you have the API key, set it in an environment variable called `OPENAI_API_KEY`
-
-```python
-import os
-os.environ["OPENAI_API_KEY"] = "sk-xxxx"
-```
-
-### Llama2App
-
-```python
-import os
-
-from embedchain import Llama2App
-
-os.environ['REPLICATE_API_TOKEN'] = "REPLICATE API TOKEN"
-
-zuck_bot = Llama2App()
-
-# Embed your data
-zuck_bot.add("https://www.youtube.com/watch?v=Ff4fRgnuFgQ")
-zuck_bot.add("https://en.wikipedia.org/wiki/Mark_Zuckerberg")
-
-# Nice, your bot is ready now. Start asking questions to your bot.
-zuck_bot.query("Who is Mark Zuckerberg?")
-# Answer: Mark Zuckerberg is an American internet entrepreneur and business magnate. He is the co-founder and CEO of Facebook. Born in 1984, he dropped out of Harvard University to focus on his social media platform, which has since grown to become one of the largest and most influential technology companies in the world.
-
-# Enable web search for your bot
-zuck_bot.online = True # enable internet access for the bot
-zuck_bot.query("Who owns the new threads app and when it was founded?")
-# Answer: Based on the context provided, the new Threads app is owned by Meta, the parent company of Facebook, Instagram, and WhatsApp.
-```
-
- `Llama2App` uses Replicate's LLM model, so these are paid models. You can get the `REPLICATE_API_TOKEN` by registering on [their website](https://replicate.com/account).
- `Llama2App` uses OpenAI's embedding model to create embeddings for chunks. Make sure that you have an OpenAI account and an API key. If you don't have an API key, you can create one by visiting [this link](https://platform.openai.com/account/api-keys).
-
-
-### OpenSourceApp
-
-```python
-from embedchain import OpenSourceApp
-app = OpenSourceApp()
-```
-
- `OpenSourceApp` uses open source embedding and LLM model. It uses `all-MiniLM-L6-v2` from Sentence Transformers library as the embedding model and `gpt4all` as the LLM.
- Here there is no need to setup any api keys. You just need to install embedchain package and these will get automatically installed. 📦
- Once you have imported and instantiated the app, every functionality from here onwards is the same for either type of app. 📚
- `OpenSourceApp` is opinionated. It uses the best open source embedding model and LLM on the market.
- extra dependencies are required for this app type. Install them with `pip install --upgrade embedchain[opensource]`.
-
-### CustomApp
-
-```python
-from embedchain import CustomApp
-from embedchain.config import (CustomAppConfig, ElasticsearchDBConfig,
-                               EmbedderConfig, LlmConfig)
-from embedchain.embedder.vertexai import VertexAiEmbedder
-from embedchain.llm.vertex_ai import VertexAiLlm
-from embedchain.models import EmbeddingFunctions, Providers
-from embedchain.vectordb.elasticsearch import Elasticsearch
-
-# short
-app = CustomApp(llm=VertexAiLlm(), db=Elasticsearch(), embedder=VertexAiEmbedder())
-# with configs
-app = CustomApp(
-    config=CustomAppConfig(log_level="INFO"),
-    llm=VertexAiLlm(config=LlmConfig(number_documents=5)),
-    db=Elasticsearch(config=ElasticsearchDBConfig(es_url="...")),
-    embedder=VertexAiEmbedder(config=EmbedderConfig()),
-)
-```
-
- `CustomApp` is not opinionated.
- Configuration required. It's for advanced users who want to mix and match different embedding models and LLMs.
- while it's doing that, it's still providing abstractions by allowing you to import Classes from `embedchain.llm`, `embedchain.vectordb`, and `embedchain.embedder`.
- paid and free/open source providers included.
- Once you have imported and instantiated the app, every functionality from here onwards is the same for either type of app. 📚
- Following providers are available for an LLM
-    - OPENAI
-    - ANTHPROPIC
-    - VERTEX_AI
-    - GPT4ALL
-    - AZURE_OPENAI
-    - LLAMA2
- Following embedding functions are available for an embedding function
-    - OPENAI
-    - HUGGING_FACE
-    - VERTEX_AI
-    - GPT4ALL
-    - AZURE_OPENAI
-
-
-### PersonApp
-
-```python
-from embedchain import PersonApp
-naval_chat_bot = PersonApp("name_of_person_or_character") #Like "Yoda"
-```
-
- `PersonApp` uses OpenAI's model, so these are paid models. 💸 You will be charged for embedding model usage and LLM usage.
- `PersonApp` uses OpenAI's embedding model to create embeddings for chunks and ChatGPT API as LLM to get answer given the relevant docs. Make sure that you have an OpenAI account and an API key. If you don't have an API key, you can create one by visiting [this link](https://platform.openai.com/account/api-keys).
- Once you have the API key, set it in an environment variable called `OPENAI_API_KEY`
-
-```python
-import os
-os.environ["OPENAI_API_KEY"] = "sk-xxxx"
-```
-
-#### Compatibility with other apps
-
- If there is any other app instance in your script or app, you can change the import as
-
-```python
-from embedchain import App as EmbedChainApp
-from embedchain import OpenSourceApp as EmbedChainOSApp
-from embedchain import PersonApp as EmbedChainPersonApp
-
-# or
-
-from embedchain import App as ECApp
-from embedchain import OpenSourceApp as ECOSApp
-from embedchain import PersonApp as ECPApp
-```
@@ -4,101 +4,72 @@ title: '⚙️ Custom configurations'

 Embedchain is made to work out of the box. However, for advanced users we're also offering configuration options. All of these configuration options are optional and have sane defaults.

-## Concept
-The main `App` class is available in the following varieties: `CustomApp`, `OpenSourceApp` and `Llama2App` and `App`. The first is fully configurable, the others are opinionated in some aspects.
+You can configure different components of your app (`llm`, `embedding model`, or `vector database`) through a simple yaml configuration that Embedchain offers. Here is a generic full-stack example of the yaml config:

-The `App` class has three subclasses: `llm`, `db` and `embedder`. These are the core ingredients that make up an EmbedChain app.
-App plus each one of the subclasses have a `config` attribute.
-You can pass a `Config` instance as an argument during initialization to persistently configure a class.
-These configs can be imported from `embedchain.config`
+```yaml
+app:
+  config:
+    id: 'full-stack-app'

-There are `set` methods for some things that should not (only) be set at start-up, like `app.db.set_collection_name`.
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+    template: |
+      Use the following pieces of context to answer the query at the end.
+      If you don't know the answer, just say that you don't know, don't try to make up an answer.

-## Examples
+      $context

-### General
+      Query: $query

-Here's the readme example with configuration options.
+      Helpful Answer:
+    system_prompt: |
+      Act as William Shakespeare. Answer the following questions in the style of William Shakespeare.

-```python
-from embedchain import App
-from embedchain.config import AppConfig, AddConfig, LlmConfig, ChunkerConfig
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'full-stack-app'
+    dir: db
+    allow_reset: true

-# Example: set the log level for debugging
-config = AppConfig(log_level="DEBUG")
-naval_chat_bot = App(config)
-
-# Example: specify a custom collection name
-naval_chat_bot.db.set_collection_name("naval_chat_bot")
-
-# Example: define your own chunker config for `youtube_video`
-chunker_config = ChunkerConfig(chunk_size=1000, chunk_overlap=100, length_function=len)
-# Example: Add your chunker config to an AddConfig to actually use it
-add_config = AddConfig(chunker=chunker_config)
-naval_chat_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44", config=add_config)
-
-# Example: Reset to default
-add_config = AddConfig()
-naval_chat_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf", config=add_config)
-naval_chat_bot.add("https://nav.al/feedback", config=add_config)
-naval_chat_bot.add("https://nav.al/agi", config=add_config)
-naval_chat_bot.add(("Who is Naval Ravikant?", "Naval Ravikant is an Indian-American entrepreneur and investor."), config=add_config)
-
-# Change the number of documents.
-query_config = LlmConfig(number_documents=5)
-print(naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?", config=query_config))
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
 ```

-### Custom prompt template
+Alright, let's dive into what each key means in the yaml config above:

-Here's the example of using custom prompt template with `.query`
+1. `app` Section:
+    - `config`:
+        - `id` (String): The ID or name of your full-stack application.
+2. `llm` Section:
+    - `provider` (String): The provider for the language model, which is set to 'openai'. You can find the full list of llm providers in [our docs](/components/llms).
+    - `model` (String): The specific model being used, 'gpt-3.5-turbo'.
+    - `config`:
+        - `temperature` (Float): Controls the randomness of the model's output. A higher value (closer to 1) makes the output more random.
+        - `max_tokens` (Integer): Controls how many tokens are used in the response.
+        - `top_p` (Float): Controls the diversity of word selection. A higher value (closer to 1) makes word selection more diverse.
+        - `stream` (Boolean): Controls if the response is streamed back to the user (set to false).
+        - `template` (String): A custom template for the prompt that the model uses to generate responses.
+        - `system_prompt` (String): A system prompt for the model to follow when generating responses, in this case, it's set to the style of William Shakespeare.
+3. `vectordb` Section:
+    - `provider` (String): The provider for the vector database, set to 'chroma'. You can find the full list of vector database providers in [our docs](/components/vector-databases).
+    - `config`:
+        - `collection_name` (String): The initial collection name for the database, set to 'full-stack-app'.
+        - `dir` (String): The directory for the database, set to 'db'.
+        - `allow_reset` (Boolean): Indicates whether resetting the database is allowed, set to true.
+4. `embedder` Section:
+    - `provider` (String): The provider for the embedder, set to 'openai'. You can find the full list of embedding model providers in [our docs](/components/embedding-models).
+    - `config`:
+        - `model` (String): The specific model used for text embedding, 'text-embedding-ada-002'.

-```python
-from string import Template
+If you have questions about the configuration above, please feel free to reach out to us using one of the following methods:

-import wikipedia
-
-from embedchain import App
-from embedchain.config import LlmConfig
-
-einstein_chat_bot = App()
-
-# Embed Wikipedia page
-page = wikipedia.page("Albert Einstein")
-einstein_chat_bot.add(page.content)
-
-# Example: use your own custom template with `$context` and `$query`
-einstein_chat_template = Template(
-    """
-        You are Albert Einstein, a German-born theoretical physicist,
-        widely ranked among the greatest and most influential scientists of all time.
-
-        Use the following information about Albert Einstein to respond to
-        the human's query acting as Albert Einstein.
-        Context: $context
-
-        Keep the response brief. If you don't know the answer, just say that you don't know, don't try to make up an answer.
-
-        Human: $query
-        Albert Einstein:"""
-)
-# Example: Use the template, also add a system prompt.
-llm_config = LlmConfig(template=einstein_chat_template, system_prompt="You are Albert Einstein.")
-queries = [
-    "Where did you complete your studies?",
-    "Why did you win nobel prize?",
-    "Why did you divorce your first wife?",
-]
-for query in queries:
-    response = einstein_chat_bot.query(query, config=llm_config)
-    print("Query: ", query)
-    print("Response: ", response)
-
-# Output
-# Query:  Where did you complete your studies?
-# Response:  I completed my secondary education at the Argovian cantonal school in Aarau, Switzerland.
-# Query:  Why did you win nobel prize?
-# Response:  I won the Nobel Prize in Physics in 1921 for my services to Theoretical Physics, particularly for my discovery of the law of the photoelectric effect.
-# Query:  Why did you divorce your first wife?
-# Response:  We divorced due to living apart for five years.
-```
+<Snippet file="get-help.mdx" />
@@ -1,160 +0,0 @@
---
-title: '📋 Supported data formats'
---
-
-## Automatic data type detection
-The add method automatically tries to detect the data_type, based on your input for the source argument. So `app.add('https://www.youtube.com/watch?v=dQw4w9WgXcQ')` is enough to embed a YouTube video.
-
-This detection is implemented for all formats. It is based on factors such as whether it's a URL, a local file, the source data type, etc.
-
-### Debugging automatic detection
-
-
-Set `log_level=DEBUG` (in [AppConfig](http://localhost:3000/advanced/query_configuration#appconfig)) and make sure it's working as intended.
-
-Otherwise, you will not know when, for instance, an invalid filepath is interpreted as raw text instead.
-
-### Forcing a data type
-
-To omit any issues with the data type detection, you can **force** a data_type by adding it as a `add` method argument.
-The examples below show you the keyword to force the respective `data_type`.
-
-Forcing can also be used for edge cases, such as interpreting a sitemap as a web_page, for reading its raw text instead of following links.
-
-## Remote Data Types
-
-<Tip>
-**Use local files in remote data types**
-
-Some data_types are meant for remote content and only work with URLs.
-You can pass local files by formatting the path using the `file:` [URI scheme](https://en.wikipedia.org/wiki/File_URI_scheme), e.g. `file:///info.pdf`.
-</Tip>
-
-### Youtube video
-
-To add any youtube video to your app, use the data_type (first argument to `.add()` method) as `youtube_video`. Eg:
-
-```python
-app.add('a_valid_youtube_url_here', data_type='youtube_video')
-```
-
-### PDF file
-
-To add any pdf file, use the data_type as `pdf_file`. Eg:
-
-```python
-app.add('a_valid_url_where_pdf_file_can_be_accessed', data_type='pdf_file')
-```
-
-Note that we do not support password protected pdfs.
-
-### Web page
-
-To add any web page, use the data_type as `web_page`. Eg:
-
-```python
-app.add('a_valid_web_page_url', data_type='web_page')
-```
-
-### Sitemap
-
-Add all web pages from an xml-sitemap. Filters non-text files. Use the data_type as `sitemap`. Eg:
-
-```python
-app.add('https://example.com/sitemap.xml', data_type='sitemap')
-```
-
-### Doc file
-
-To add any doc/docx file, use the data_type as `docx`. `docx` allows remote urls and conventional file paths. Eg:
-
-```python
-app.add('https://example.com/content/intro.docx', data_type="docx")
-app.add('content/intro.docx', data_type="docx")
-```
-
-### CSV file
-
-To add any csv file, use the data_type as `csv`. `csv` allows remote urls and conventional file paths. Headers are included for each line, so if you have an `age` column, `18` will be added as `age: 18`. Eg:
-
-```python
-app.add('https://example.com/content/sheet.csv', data_type="csv")
-app.add('content/sheet.csv', data_type="csv")
-```
-
-Note: There is a size limit allowed for csv file beyond which it can throw error. This limit is set by the LLMs. Please consider chunking large csv files into smaller csv files.
-
-### Code documentation website loader
-
-To add any code documentation website as a loader, use the data_type as `docs_site`. Eg:
-
-```python
-app.add("https://docs.embedchain.ai/", data_type="docs_site")
-```
-
-### Notion
-To use notion you must install the extra dependencies with `pip install --upgrade embedchain[notion]`.
-
-To load a notion page, use the data_type as `notion`. Since it is hard to automatically detect, forcing this is advised.
-The next argument must **end** with the `notion page id`. The id is a 32-character string. Eg:
-
-```python
-app.add("cfbc134ca6464fc980d0391613959196", "notion")
-app.add("my-page-cfbc134ca6464fc980d0391613959196", "notion")
-app.add("https://www.notion.so/my-page-cfbc134ca6464fc980d0391613959196", "notion")
-```
-
-### Mdx file
-
-To add any mdx file to your app, use the data_type (first argument to `.add()` method) as `mdx`. Note that this supports support mdx file present on machine, so this should be a file path. Eg:
-
-```python
-app.add('path/to/file.mdx', data_type='mdx')
-```
-
-## Local Data Types
-
-### Text
-
-To supply your own text, use the data_type as `text` and enter a string. The text is not processed, this can be very versatile. Eg:
-
-```python
-app.add('Seek wealth, not money or status. Wealth is having assets that earn while you sleep. Money is how we transfer time and wealth. Status is your place in the social hierarchy.', data_type='text')
-```
-
-Note: This is not used in the examples because in most cases you will supply a whole paragraph or file, which did not fit.
-
-### QnA pair
-
-To supply your own QnA pair, use the data_type as `qna_pair` and enter a tuple. Eg:
-
-```python
-app.add(("Question", "Answer"), data_type="qna_pair")
-```
-
-## Reusing a vector database
-
-Default behavior is to create a persistent vector DB in the directory **./db**. You can split your application into two Python scripts: one to create a local vector DB and the other to reuse this local persistent vector DB. This is useful when you want to index hundreds of documents and separately implement a chat interface.
-
-Create a local index:
-
-```python
-from embedchain import App
-
-naval_chat_bot = App()
-naval_chat_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44")
-naval_chat_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf")
-```
-
-You can reuse the local index with the same code, but without adding new documents:
-
-```python
-from embedchain import App
-
-naval_chat_bot = App()
-print(naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?"))
-```
-
-## More formats (coming soon!)
-
- If you want to add any other format, please create an [issue](https://github.com/embedchain/embedchain/issues) and we will add it to the list of supported formats.
@@ -1,75 +0,0 @@
---
-title: '🤝 Interface types'
---
-
-## Interface Types
-
-The embedchain app exposes the following methods.
-
-### Query Interface
-
- This interface is like a question answering bot. It takes a question and gets the answer. It does not maintain context about the previous chats.❓
-
- To use this, call `.query()` function to get the answer for any query.
-
-```python
-print(naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?"))
-# answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
-```
-
-### Chat Interface
-
- This interface is a chat interface that remembers previous conversations. Right now it remembers 5 conversations by default. 💬
-
- To use this, call `.chat` function to get the answer for any query.
-
-```python
-print(naval_chat_bot.chat("How to be happy in life?"))
-# answer: The most important trick to being happy is to realize happiness is a skill you develop and a choice you make. You choose to be happy, and then you work at it. It's just like building muscles or succeeding at your job. It's about recognizing the abundance and gifts around you at all times.
-
-print(naval_chat_bot.chat("who is naval ravikant?"))
-# answer: Naval Ravikant is an Indian-American entrepreneur and investor.
-
-print(naval_chat_bot.chat("what did the author say about happiness?"))
-# answer: The author, Naval Ravikant, believes that happiness is a choice you make and a skill you develop. He compares the mind to the body, stating that just as the body can be molded and changed, so can the mind. He emphasizes the importance of being present in the moment and not getting caught up in regrets of the past or worries about the future. By being present and grateful for where you are, you can experience true happiness.
-```
-
-#### Dry Run
-
-Dry Run is an option in the `add`, `query` and `chat` methods that allows the user to display the data chunks and their constructed prompt which is not sent to the LLM, to save money. It's used for [testing](/advanced/testing#dry-run).
-
-
-### Stream Response
-
- You can add config to your query method to stream responses like ChatGPT does. You would require a downstream handler to render the chunk in your desirable format. Supports both OpenAI model and OpenSourceApp. 📊
-
- To use this, instantiate a `LlmConfig` or `ChatConfig` object with `stream=True`. Then pass it to the `.chat()` or `.query()` method. The following example iterates through the chunks and prints them as they appear.
-
-```python
-app = App()
-query_config = LlmConfig(stream = True)
-resp = app.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?", query_config)
-
-for chunk in resp:
-    print(chunk, end="", flush=True)
-# answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
-```
-
-### Other Methods
-
-#### Reset
-
-Resets the database and deletes all embeddings. Irreversible. Requires reinitialization afterwards.
-
-```python
-app.reset()
-```
-
-#### Count
-
-Counts the number of embeddings (chunks) in the database.
-
-```python
-print(app.db.count())
-# returns: 481
-```
@@ -1,79 +0,0 @@
---
-title: '🔍 Query configurations'
---
-
-## AppConfig
-
-| option    | description           | type                            | default                |
-|-----------|-----------------------|---------------------------------|------------------------|
-| log_level | log level             | string                          | WARNING                |
-| embedding_fn| embedding function    | chromadb.utils.embedding_functions | \{text-embedding-ada-002\} |
-| db        | vector database (experimental) | BaseVectorDB               | ChromaDB               |
-| collection_name | initial collection name for the database | string             | embedchain_store |
-| collect_metrics | collect anonymous telemetry data to improve embedchain | boolean | true |
-
-
-## AddConfig
-
-|option|description|type|default|
-|---|---|---|---|
-|chunker|chunker config|ChunkerConfig|Default values for chunker depends on the `data_type`. Please refer [ChunkerConfig](#chunker-config)|
-|loader|loader config|LoaderConfig|None|
-
-Yes, you are passing `ChunkerConfig` to `AddConfig`, like so:
-
-```python
-chunker_config = ChunkerConfig(chunk_size=100)
-add_config = AddConfig(chunker=chunker_config)
-app.add("lorem ipsum", config=add_config)
-```
-
-### ChunkerConfig
-
-|option|description|type|default|
-|---|---|---|---|
-|chunk_size|Maximum size of chunks to return|int|Default value for various `data_type` mentioned below|
-|chunk_overlap|Overlap in characters between chunks|int|Default value for various `data_type` mentioned below|
-|length_function|Function that measures the length of given chunks|typing.Callable|Default value for various `data_type` mentioned below|
-
-Default values of chunker config parameters for different `data_type`:
-
-|data_type|chunk_size|chunk_overlap|length_function|
-|---|---|---|---|
-|docx|1000|0|len|
-|text|300|0|len|
-|qna_pair|300|0|len|
-|web_page|500|0|len|
-|pdf_file|1000|0|len|
-|youtube_video|2000|0|len|
-|docs_site|500|50|len|
-|notion|300|0|len|
-
-### LoaderConfig
-
-_coming soon_
-
-## LlmConfig
-
-|option|description|type|default|
-|---|---|---|---|
-|number_documents|Absolute number of documents to pull from the database as context.|int|1
-|template|custom template for prompt. If history is used with query, $history has to be included as well.|Template|Template("Use the following pieces of context to answer the query at the end. If you don't know the answer, just say that you don't know, don't try to make up an answer. \$context Query: \$query Helpful Answer:")|
-|model|name of the model used.|string|depends on app type|
-|temperature|Controls the randomness of the model's output. Higher values (closer to 1) make output more random, lower values make it more deterministic.|float|0|
-|max_tokens|Controls how many tokens are used. Exact implementation (whether it counts prompt and/or response) depends on the model.|int|1000|
-|top_p|Controls the diversity of words. Higher values (closer to 1) make word selection more diverse, lower values make words less diverse.|float|1|
-|history|include conversation history from your client or database.|any (recommendation: list[str])|None|
-|stream|control if response is streamed back to the user.|bool|False|
-|deployment_name|t.b.a.|str|None|
-|system_prompt|System prompt string. Unused if none.|str|None|
-|where|filter for context search.|dict|None|
-
-
-## ChatConfig
-
-All options for query and...
-
-_coming soon_
-
-`history` is not supported, as that is handled is handled automatically, the config option is not supported.
@@ -1,40 +0,0 @@
---
-title: '🧪 Testing'
---
-
-## Methods for testing
-
-### Dry Run
-
-Before you consume valueable tokens, you should make sure that data chunks are properly created and the embedding you have done works and that it's receiving the correct document from the database.
-
- For `query` or `chat` method, you can add this to your script:
-
-```python
-print(naval_chat_bot.query('Can you tell me who Naval Ravikant is?', dry_run=True))
-
-'''
-Use the following pieces of context to answer the query at the end. If you don't know the answer, just say that you don't know, don't try to make up an answer.
-        Q: Who is Naval Ravikant?
-A: Naval Ravikant is an Indian-American entrepreneur and investor.
-        Query: Can you tell me who Naval Ravikant is?
-        Helpful Answer:
-'''
-```
-
-_The embedding is confirmed to work as expected. It returns the right document, even if the question is asked slightly different. No prompt tokens have been consumed._
-
-The dry run will still consume tokens to embed your query, but it is only **~1/15 of the prompt.**
-
-
- For `add` method, you can add this to your script:
-
-```python
-print(naval_chat_bot.add('https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf', dry_run=True))
-
-'''
-{'chunks': ['THE ALMANACK OF NAVAL RAVIKANT', 'GETTING RICH IS NOT JUST ABOUT LUCK;', 'HAPPINESS IS NOT JUST A TRAIT WE ARE'], 'metadata': [{'source': 'C:\\Users\\Dev\\AppData\\Local\\Temp\\tmp3g5mjoiz\\tmp.pdf', 'page': 0, 'url': 'https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf', 'data_type': 'pdf_file'}, {'source': 'C:\\Users\\Dev\\AppData\\Local\\Temp\\tmp3g5mjoiz\\tmp.pdf', 'page': 2, 'url': 'https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf', 'data_type': 'pdf_file'}, {'source': 'C:\\Users\\Dev\\AppData\\Local\\Temp\\tmp3g5mjoiz\\tmp.pdf', 'page': 2, 'url': 'https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf', 'data_type': 'pdf_file'}], 'count': 7358, 'type': <DataType.PDF_FILE: 'pdf_file'>}
-
-# less items to show for readability
-'''
-```
@@ -1,118 +0,0 @@
---
-title: '💾 Vector Database'
---
-
-We support `Chroma`, `Elasticsearch` and `OpenSearch` as vector databases.
-`Chroma` is used as a default database.
-
-## Elasticsearch
-
-### Minimal Example
-
-In order to use `Elasticsearch` as vector database we need to use App type `CustomApp`.
-
-1. Set the environment variables in a `.env` file.
-```
-OPENAI_API_KEY=sk-SECRETKEY
-ELASTICSEARCH_API_KEY=SECRETKEY==
-ELASTICSEARCH_URL=https://secret-domain.europe-west3.gcp.cloud.es.io:443
-```
-Please note that the key needs certain privileges. For testing you can just toggle off `restrict privileges` under `/app/management/security/api_keys/` in your web interface.
-
-2. Load the app
-```python
-from embedchain import CustomApp
-from embedchain.embedder.openai import OpenAIEmbedder
-from embedchain.llm.openai import OpenAILlm
-from embedchain.vectordb.elasticsearch import ElasticsearchDB
-
-es_app = CustomApp(
-    llm=OpenAILlm(),
-    embedder=OpenAIEmbedder(),
-    db=ElasticsearchDB(),
-)
-```
-
-### More custom settings
-
-You can get a URL for elasticsearch in the cloud, or run it locally. 
-The following example shows you how to configure embedchain to work with a locally running elasticsearch.
-
-Instead of using an API key, we use http login credentials. The localhost url can be defined in .env or in the config.
-
-```python
-import os
-
-from embedchain import CustomApp
-from embedchain.config import CustomAppConfig, ElasticsearchDBConfig
-from embedchain.embedder.openai import OpenAIEmbedder
-from embedchain.llm.openai import OpenAILlm
-from embedchain.vectordb.elasticsearch import ElasticsearchDB
-
-es_config = ElasticsearchDBConfig(
-    # elasticsearch url or list of nodes url with different hosts and ports.
-    es_url='https://localhost:9200',
-    # pass named parameters supported by Python Elasticsearch client
-    http_auth=("elastic", "secret"),
-    ca_certs="~/binaries/elasticsearch-8.7.0/config/certs/http_ca.crt" # your cert path
-    # verify_certs=False # Alternative, if you aren't using certs
-) # pass named parameters supported by elasticsearch-py
-
-es_app = CustomApp(
-    config=CustomAppConfig(log_level="INFO"),
-    llm=OpenAILlm(),
-    embedder=OpenAIEmbedder(),
-    db=ElasticsearchDB(config=es_config),
-)
-```
-3. This should log your connection details to the console.
-4. Alternatively to a URL, you `ElasticsearchDBConfig` accepts `es_url` as a list of nodes url with different hosts and ports.
-5. Additionally we can pass named parameters supported by Python Elasticsearch client.
-
-
-## OpenSearch 🔍
-
-To use OpenSearch as a vector database with a CustomApp, follow these simple steps:
-
-1. Set the `OPENAI_API_KEY` environment variable:
-
-```
-OPENAI_API_KEY=sk-xxxx
-```
-
-2. Define the OpenSearch configuration in your Python code:
-
-```python
-from embedchain import CustomApp
-from embedchain.config import OpenSearchDBConfig
-from embedchain.embedder.openai import OpenAIEmbedder
-from embedchain.llm.openai import OpenAILlm
-from embedchain.vectordb.opensearch import OpenSearchDB
-
-opensearch_url = "https://localhost:9200"
-http_auth = ("username", "password")
-
-db_config = OpenSearchDBConfig(
-    opensearch_url=opensearch_url,
-    http_auth=http_auth,
-    collection_name="embedchain-app",
-    use_ssl=True,
-    timeout=30,
-)
-db = OpenSearchDB(config=db_config)
-```
-
-2. Instantiate the app and add data:
-
-```python
-app = CustomApp(llm=OpenAILlm(), embedder=OpenAIEmbedder(), db=db)
-app.add("https://en.wikipedia.org/wiki/Elon_Musk")
-app.add("https://www.forbes.com/profile/elon-musk")
-app.add("https://www.britannica.com/biography/Elon-Musk")
-```
-
-3. You're all set! Start querying using the following command:
-
-```python
-app.query("What is the net worth of Elon Musk?")
-```
@@ -0,0 +1,28 @@
+---
+title: 🤝 Connect with Us
+---
+
+We believe in building a vibrant and supportive community around embedchain. There are various channels through which you can connect with us, stay updated, and contribute to the ongoing discussions:
+
+<CardGroup cols={3}>
+  <Card title="Twitter" icon="twitter" href="https://twitter.com/embedchain">
+    Follow us on Twitter
+  </Card>
+  <Card title="Slack" icon="slack" href="https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw" color="#4A154B">
+    Join our slack community
+  </Card>
+  <Card title="Discord" icon="discord" href="https://discord.gg/6PzXDgEjG5" color="#7289DA">
+    Join our discord community
+  </Card>
+  <Card title="LinkedIn" icon="linkedin" href="https://www.linkedin.com/company/embedchain/">
+  Connect with us on LinkedIn
+  </Card>
+  <Card title="Schedule a call" icon="calendar" href="https://cal.com/taranjeetio/ec">
+  Schedule a call with Embedchain founder
+  </Card>
+  <Card title="Newsletter" icon="message" href="https://embedchain.substack.com/">
+  Subscribe to our newsletter
+  </Card>
+</CardGroup>
+
+We look forward to connecting with you and seeing how we can create amazing things together!
@@ -0,0 +1,175 @@
+---
+title: 🧩 Embedding models
+---
+
+## Overview
+
+Embedchain supports several embedding models from the following providers:
+
+<CardGroup cols={4}>
+  <Card title="OpenAI" href="#openai"></Card>
+  <Card title="Azure OpenAI" href="#azure-openai"></Card>
+  <Card title="GPT4All" href="#gpt4all"></Card>
+  <Card title="Hugging Face" href="#hugging-face"></Card>
+  <Card title="Vertex AI" href="#vertex-ai"></Card>
+</CardGroup>
+
+## OpenAI
+
+To use OpenAI embedding function, you have to set the `OPENAI_API_KEY` environment variable. You can obtain the OpenAI API key from the [OpenAI Platform](https://platform.openai.com/account/api-keys).
+
+Once you have obtained the key, you can use it like this:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+# load embedding model configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+
+app.add("https://en.wikipedia.org/wiki/OpenAI")
+app.query("What is OpenAI?")
+```
+
+```yaml config.yaml
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
+```
+
+</CodeGroup>
+
+## Azure OpenAI
+
+To use Azure OpenAI embedding model, you have to set some of the azure openai related environment variables as given in the code block below:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["OPENAI_API_TYPE"] = "azure"
+os.environ["OPENAI_API_BASE"] = "https://xxx.openai.azure.com/"
+os.environ["OPENAI_API_KEY"] = "xxx"
+os.environ["OPENAI_API_VERSION"] = "xxx"
+
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: azure_openai
+  model: gpt-35-turbo
+  config:
+    deployment_name: your_llm_deployment_name
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: azure_openai
+  config:
+    model: text-embedding-ada-002
+    deployment_name: you_embedding_model_deployment_name
+```
+</CodeGroup>
+
+You can find the list of models and deployment name on the [Azure OpenAI Platform](https://oai.azure.com/portal).
+
+## GPT4ALL
+
+GPT4All supports generating high quality embeddings of arbitrary length documents of text using a CPU optimized contrastively trained Sentence Transformer.
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load embedding model configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: gpt4all
+  model: 'orca-mini-3b.ggmlv3.q4_0.bin'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: gpt4all
+  config:
+    model: 'all-MiniLM-L6-v2'
+```
+
+</CodeGroup>
+
+## Hugging Face
+
+Hugging Face supports generating embeddings of arbitrary length documents of text using Sentence Transformer library. Example of how to generate embeddings using hugging face is given below:
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load embedding model configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: huggingface
+  model: 'google/flan-t5-xxl'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 0.5
+    stream: false
+
+embedder:
+  provider: huggingface
+  config:
+    model: 'sentence-transformers/all-mpnet-base-v2'
+```
+
+</CodeGroup>
+
+## Vertex AI
+
+Embedchain supports Google's VertexAI embeddings model through a simple interface. You just have to pass the `model_name` in the config yaml and it would work out of the box.
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load embedding model configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: vertexai
+  model: 'chat-bison'
+  config:
+    temperature: 0.5
+    top_p: 0.5
+
+embedder:
+  provider: vertexai
+  config:
+    model: 'textembedding-gecko'
+```
+
+</CodeGroup>
@@ -0,0 +1,327 @@
+---
+title: 🤖 Large language models (LLMs)
+---
+
+## Overview
+
+Embedchain comes with built-in support for various popular large language models. We handle the complexity of integrating these models for you, allowing you to easily customize your language model interactions through a user-friendly interface.
+
+<CardGroup cols={4}>
+  <Card title="OpenAI" href="#openai"></Card>
+  <Card title="Azure OpenAI" href="#azure-openai"></Card>
+  <Card title="Anthropic" href="#anthropic"></Card>
+  <Card title="Cohere" href="#cohere"></Card>
+  <Card title="GPT4All" href="#gpt4all"></Card>
+  <Card title="JinaChat" href="#jinachat"></Card>
+  <Card title="Hugging Face" href="#hugging-face"></Card>
+  <Card title="Llama2" href="#llama2"></Card>
+  <Card title="Vertex AI" href="#vertex-ai"></Card>
+</CardGroup>
+
+## OpenAI
+
+To use OpenAI LLM models, you have to set the `OPENAI_API_KEY` environment variable. You can obtain the OpenAI API key from the [OpenAI Platform](https://platform.openai.com/account/api-keys).
+
+Once you have obtained the key, you can use it like this:
+
+```python
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+app = App()
+app.add("https://en.wikipedia.org/wiki/OpenAI")
+app.query("What is OpenAI?")
+```
+
+If you are looking to configure the different parameters of the LLM, you can do so by loading the app using a [yaml config](https://github.com/embedchain/embedchain/blob/main/configs/chroma.yaml) file.
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+
+</CodeGroup>
+
+
+## Azure OpenAI
+
+To use Azure OpenAI model, you have to set some of the azure openai related environment variables as given in the code block below:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["OPENAI_API_TYPE"] = "azure"
+os.environ["OPENAI_API_BASE"] = "https://xxx.openai.azure.com/"
+os.environ["OPENAI_API_KEY"] = "xxx"
+os.environ["OPENAI_API_VERSION"] = "xxx"
+
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: azure_openai
+  model: gpt-35-turbo
+  config:
+    deployment_name: your_llm_deployment_name
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: azure_openai
+  config:
+    model: text-embedding-ada-002
+    deployment_name: you_embedding_model_deployment_name
+```
+</CodeGroup>
+
+You can find the list of models and deployment name on the [Azure OpenAI Platform](https://oai.azure.com/portal).
+
+## Anthropic
+
+To use anthropic's model, please set the `ANTHROPIC_API_KEY` which you find on their [Account Settings Page](https://console.anthropic.com/account/keys).
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["ANTHROPIC_API_KEY"] = "xxx"
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: anthropic
+  model: 'claude-instant-1'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+
+</CodeGroup>
+
+## Cohere
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[cohere]'
+```
+
+Set the `COHERE_API_KEY` as environment variable which you can find on their [Account settings page](https://dashboard.cohere.com/api-keys).
+
+Once you have the API key, you are all set to use it with Embedchain.
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["COHERE_API_KEY"] = "xxx"
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: cohere
+  model: large
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+```
+
+</CodeGroup>
+
+## GPT4ALL
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[opensource]'
+```
+
+GPT4all is a free-to-use, locally running, privacy-aware chatbot. No GPU or internet required. You can use this with Embedchain using the following code:
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: gpt4all
+  model: 'orca-mini-3b.ggmlv3.q4_0.bin'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: gpt4all
+  config:
+    model: 'all-MiniLM-L6-v2'
+```
+</CodeGroup>
+
+
+## JinaChat
+
+First, set `JINACHAT_API_KEY` in environment variable which you can obtain from [their platform](https://chat.jina.ai/api).
+
+Once you have the key, load the app using the config yaml file:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["JINACHAT_API_KEY"] = "xxx"
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: jina
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+</CodeGroup>
+
+
+## Hugging Face
+
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[huggingface_hub]'
+```
+
+First, set `HUGGINGFACE_ACCESS_TOKEN` in environment variable which you can obtain from [their platform](https://huggingface.co/settings/tokens).
+
+Once you have the token, load the app using the config yaml file:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["HUGGINGFACE_ACCESS_TOKEN"] = "xxx"
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: huggingface
+  model: 'google/flan-t5-xxl'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 0.5
+    stream: false
+```
+</CodeGroup>
+
+## Llama2
+
+Llama2 is integrated through [Replicate](https://replicate.com/).  Set `REPLICATE_API_TOKEN` in environment variable which you can obtain from [their platform](https://replicate.com/account/api-tokens).
+
+Once you have the token, load the app using the config yaml file:
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ["REPLICATE_API_TOKEN"] = "xxx"
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: llama2
+  model: 'a16z-infra/llama13b-v2-chat:df7690f1994d94e96ad9d568eac121aecf50684a0b0963b25a41cc40061269e5'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 0.5
+    stream: false
+```
+</CodeGroup>
+
+## Vertex AI
+
+Setup Google Cloud Platform application credentials by following the instruction on [GCP](https://cloud.google.com/docs/authentication/external/set-up-adc). Once setup is done, use the following code to create an app using VertexAI as provider:
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load llm configuration from config.yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+llm:
+  provider: vertexai
+  model: 'chat-bison'
+  config:
+    temperature: 0.5
+    top_p: 0.5
+```
+</CodeGroup>
+
+<br/ >
+<Snippet file="missing-llm-tip.mdx" />
@@ -0,0 +1,192 @@
+---
+title: 🗄️ Vector databases
+---
+
+## Overview
+
+Utilizing a vector database alongside Embedchain is a seamless process. All you need to do is configure it within the YAML configuration file. We've provided examples for each supported database below:
+
+<CardGroup cols={4}>
+  <Card title="ChromaDB" href="#chromadb"></Card>
+  <Card title="Elasticsearch" href="#elasticsearch"></Card>
+  <Card title="OpenSearch" href="#opensearch"></Card>
+  <Card title="Zilliz" href="#zilliz"></Card>
+  <Card title="LanceDB" href="#lancedb"></Card>
+  <Card title="Pinecone" href="#pinecone"></Card>
+  <Card title="Qdrant" href="#qdrant"></Card>
+  <Card title="Weaviate" href="#weaviate"></Card>
+</CardGroup>
+
+## ChromaDB
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load chroma configuration from yaml file
+app = App.from_config(yaml_path="config1.yaml")
+```
+
+```yaml config1.yaml
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-collection'
+    dir: db
+    allow_reset: true
+```
+
+```yaml config2.yaml
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-collection'
+    host: localhost
+    port: 5200
+    allow_reset: true
+```
+
+</CodeGroup>
+
+
+## Elasticsearch
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[elasticsearch]'
+```
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load elasticsearch configuration from yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+vectordb:
+  provider: elasticsearch
+  config:
+    collection_name: 'es-index'
+    es_url: http://localhost:9200
+    allow_reset: true
+    api_key: xxx
+```
+</CodeGroup>
+
+## OpenSearch
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[opensearch]'
+```
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load opensearch configuration from yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+vectordb:
+  provider: opensearch
+  config:
+    opensearch_url: 'https://localhost:9200'
+    http_auth:
+      - admin
+      - admin
+    vector_dimension: 1536
+    collection_name: 'my-app'
+    use_ssl: false
+    verify_certs: false
+```
+
+</CodeGroup>
+
+## Zilliz
+
+Install related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[milvus]'
+```
+
+Set the Zilliz environment variables `ZILLIZ_CLOUD_URI` and `ZILLIZ_CLOUD_TOKEN` which you can find it on their [cloud platform](https://cloud.zilliz.com/).
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['ZILLIZ_CLOUD_URI'] = 'https://xxx.zillizcloud.com'
+os.environ['ZILLIZ_CLOUD_TOKEN'] = 'xxx'
+
+# load zilliz configuration from yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+vectordb:
+  provider: zilliz
+  config:
+    collection_name: 'zilliz-app'
+    uri: https://xxxx.api.gcp-region.zillizcloud.com
+    token: xxx
+    vector_dim: 1536
+    metric_type: L2
+```
+
+</CodeGroup>
+
+## LanceDB
+
+_Coming soon_
+
+## Pinecone
+
+Install pinecone related dependencies using the following command:
+
+```bash
+pip install --upgrade 'embedchain[pinecone]'
+```
+
+In order to use Pinecone as vector database, set the environment variables `PINECONE_API_KEY` and `PINECONE_ENV` which you can find on [Pinecone dashboard](https://app.pinecone.io/).
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load pinecone configuration from yaml file
+app = App.from_config(yaml_path="config.yaml")
+```
+
+```yaml config.yaml
+vectordb:
+  provider: pinecone
+  config:
+    metric: cosine
+    vector_dimension: 1536
+    collection_name: my-pinecone-index
+```
+
+</CodeGroup>
+
+## Qdrant
+
+_Coming soon_
+
+## Weaviate
+
+_Coming soon_
+
+<Snippet file="missing-vector-db-tip.mdx" />
@@ -35,14 +35,10 @@ embedchain is built on the following stack:

 ## Team

-### Author
+### Authors

 - Taranjeet Singh ([@taranjeetio](https://twitter.com/taranjeetio))
-
-### Maintainer
-
 - Deshraj Yadav ([@deshrajdry](https://twitter.com/taranjeetio))
- [cachho](https://github.com/cachho)

 ### Citation

@@ -50,8 +46,8 @@ If you utilize this repository, please consider citing it with:

 ```
@misc{embedchain,
-  author = {Taranjeet Singh},
-  title = {Embechain: Framework to easily create LLM powered bots over any dataset},
+  author = {Taranjeet Singh, Deshraj Yadav},
+  title = {Embechain: Data platform for LLMs - Load, index, retrieve and sync any unstructured data},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
@@ -0,0 +1,4 @@
+---
+title: '📋 Guidelines'
+url: https://github.com/embedchain/embedchain/blob/main/CONTRIBUTING.md
+---
@@ -0,0 +1,4 @@
+---
+title: ' 🟨 Javascript'
+url: https://github.com/embedchain/embedchain/tree/main/embedchain-js
+---
@@ -0,0 +1,4 @@
+---
+title: '🐍 Python'
+url: https://github.com/embedchain/embedchain
+---
@@ -0,0 +1,19 @@
+---
+title: '📊 CSV'
+---
+
+To add any csv file, use the data_type as `csv`. `csv` allows remote urls and conventional file paths. Headers are included for each line, so if you have an `age` column, `18` will be added as `age: 18`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+app.add('https://people.sc.fsu.edu/~jburkardt/data/csv/airtravel.csv', data_type="csv")
+# Or add using the local file path
+# app.add('/path/to/file.csv', data_type="csv")
+
+app.query("Summarize the air travel data")
+# Answer: The air travel data shows the number of flights for the months of July in the years 1958, 1959, and 1960. In July 1958, there were 491 flights, in July 1959 there were 548 flights, and in July 1960 there were 622 flights.
+```
+
+Note: There is a size limit allowed for csv file beyond which it can throw error. This limit is set by the LLMs. Please consider chunking large csv files into smaller csv files.
@@ -0,0 +1,52 @@
+---
+title: 'Data type handling'
+---
+
+## Automatic data type detection
+
+The add method automatically tries to detect the data_type, based on your input for the source argument. So `app.add('https://www.youtube.com/watch?v=dQw4w9WgXcQ')` is enough to embed a YouTube video.
+
+This detection is implemented for all formats. It is based on factors such as whether it's a URL, a local file, the source data type, etc.
+
+### Debugging automatic detection
+
+Set `log_level: DEBUG` in the config yaml to debug if the data type detection is done right or not. Otherwise, you will not know when, for instance, an invalid filepath is interpreted as raw text instead.
+
+### Forcing a data type
+
+To omit any issues with the data type detection, you can **force** a data_type by adding it as a `add` method argument.
+The examples below show you the keyword to force the respective `data_type`.
+
+Forcing can also be used for edge cases, such as interpreting a sitemap as a web_page, for reading its raw text instead of following links.
+
+## Remote data types
+
+<Tip>
+**Use local files in remote data types**
+
+Some data_types are meant for remote content and only work with URLs.
+You can pass local files by formatting the path using the `file:` [URI scheme](https://en.wikipedia.org/wiki/File_URI_scheme), e.g. `file:///info.pdf`.
+</Tip>
+
+## Reusing a vector database
+
+Default behavior is to create a persistent vector db in the directory **./db**. You can split your application into two Python scripts: one to create a local vector db and the other to reuse this local persistent vector db. This is useful when you want to index hundreds of documents and separately implement a chat interface.
+
+Create a local index:
+
+```python
+from embedchain import App
+
+naval_chat_bot = App()
+naval_chat_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44")
+naval_chat_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf")
+```
+
+You can reuse the local index with the same code, but without adding new documents:
+
+```python
+from embedchain import App
+
+naval_chat_bot = App()
+print(naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?"))
+```
@@ -0,0 +1,14 @@
+---
+title: '📚🌐 Code documentation'
+---
+
+To add any code documentation website as a loader, use the data_type as `docs_site`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+app.add("https://docs.embedchain.ai/", data_type="docs_site")
+app.query("What is Embedchain?")
+# Answer: Embedchain is a platform that utilizes various components, including paid/proprietary ones, to provide what is believed to be the best configuration available. It uses LLM (Language Model) providers such as OpenAI, Anthpropic, Vertex_AI, GPT4ALL, Azure_OpenAI, LLAMA2, JINA, and COHERE. Embedchain allows users to import and utilize these LLM providers for their applications.'
+```
@@ -0,0 +1,18 @@
+---
+title: '📄 Docx file'
+---
+
+### Docx file
+
+To add any doc/docx file, use the data_type as `docx`. `docx` allows remote urls and conventional file paths. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+app.add('https://example.com/content/intro.docx', data_type="docx")
+# Or add file using the local file path on your system
+# app.add('content/intro.docx', data_type="docx")
+
+app.query("Summarize the docx data?")
+```
@@ -0,0 +1,14 @@
+---
+title: '📝 Mdx file'
+---
+
+To add any `.mdx` file to your app, use the data_type (first argument to `.add()` method) as `mdx`. Note that this supports support mdx file present on machine, so this should be a file path. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+app.add('path/to/file.mdx', data_type='mdx')
+
+app.query("What are the docs about?")
+```
@@ -0,0 +1,20 @@
+---
+title: '📓 Notion'
+---
+
+To use notion you must install the extra dependencies with `pip install --upgrade embedchain[notion]`.
+
+To load a notion page, use the data_type as `notion`. Since it is hard to automatically detect, it is advised to specify the `data_type` when adding a notion document.
+The next argument must **end** with the `notion page id`. The id is a 32-character string. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add("cfbc134ca6464fc980d0391613959196", data_type="notion")
+app.add("my-page-cfbc134ca6464fc980d0391613959196", data_type="notion")
+app.add("https://www.notion.so/my-page-cfbc134ca6464fc980d0391613959196", data_type="notion")
+
+app.query("Summarize the notion doc")
+```
@@ -0,0 +1,24 @@
+---
+title: Overview
+---
+
+Embedchain comes with built-in support for various data sources. We handle the complexity of loading unstructured data from these data sources, allowing you to easily customize your app through a user-friendly interface.
+
+<CardGroup cols={4}>
+  <Card title="📊 csv" href="/data-sources/csv"></Card>
+  <Card title="📚🌐 docs site" href="/data-sources/docs-site"></Card>
+  <Card title="📄 docx" href="/data-sources/docx"></Card>
+  <Card title="📝 mdx" href="/data-sources/mdx"></Card>
+  <Card title="📓 notion" href="/data-sources/notion"></Card>
+  <Card title="📰 pdf" href="/data-sources/pdf-file"></Card>
+  <Card title="❓💬 q&a pair" href="/data-sources/qna"></Card>
+  <Card title="🗺️ sitemap" href="/data-sources/sitemap"></Card>
+  <Card title="📝 text" href="/data-sources/text"></Card>
+  <Card title="🌐📄 web page" href="/data-sources/web-page"></Card>
+  <Card title="🧾 xml" href="/data-sources/xml"></Card>
+  <Card title="🎥📺 youtube video" href="/data-sources/youtube-video"></Card>
+</CardGroup>
+
+<br/ >
+
+<Snippet file="missing-data-source-tip.mdx" />
@@ -0,0 +1,17 @@
+---
+title: '📰 PDF file'
+---
+
+To add any pdf file, use the data_type as `pdf_file`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add('https://arxiv.org/pdf/1706.03762.pdf', data_type='pdf_file')
+app.query("What is the paper 'attention is all you need' about?")
+# Answer: The paper "Attention Is All You Need" proposes a new network architecture called the Transformer, which is based solely on attention mechanisms. It suggests moving away from complex recurrent or convolutional neural networks and instead using attention mechanisms to connect the encoder and decoder in sequence transduction models.
+```
+
+Note that we do not support password protected pdfs.
@@ -0,0 +1,13 @@
+---
+title: '❓💬 Queston and answer pair'
+---
+
+QnA pair is a local data type. To supply your own QnA pair, use the data_type as `qna_pair` and enter a tuple. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add(("Question", "Answer"), data_type="qna_pair")
+```
@@ -0,0 +1,13 @@
+---
+title: '🗺️ Sitemap'
+---
+
+Add all web pages from an xml-sitemap. Filters non-text files. Use the data_type as `sitemap`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add('https://example.com/sitemap.xml', data_type='sitemap')
+```
@@ -0,0 +1,17 @@
+---
+title: '📝 Text'
+---
+
+### Text
+
+Text is a local data type. To supply your own text, use the data_type as `text` and enter a string. The text is not processed, this can be very versatile. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add('Seek wealth, not money or status. Wealth is having assets that earn while you sleep. Money is how we transfer time and wealth. Status is your place in the social hierarchy.', data_type='text')
+```
+
+Note: This is not used in the examples because in most cases you will supply a whole paragraph or file, which did not fit.
@@ -0,0 +1,13 @@
+---
+title: '🌐📄 Web page'
+---
+
+To add any web page, use the data_type as `web_page`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add('a_valid_web_page_url', data_type='web_page')
+```
@@ -0,0 +1,17 @@
+---
+title: '🧾 XML file'
+---
+
+### XML file
+
+To add any xml file, use the data_type as `xml`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+
+app.add('content/data.xml')
+```
+
+Note: Only the text content of the xml file will be added to the app. The tags will be ignored.
@@ -0,0 +1,13 @@
+---
+title: '🎥📺 Youtube video'
+---
+
+
+To add any youtube video to your app, use the data_type (first argument to `.add()` method) as `youtube_video`. Eg:
+
+```python
+from embedchain import App
+
+app = App()
+app.add('a_valid_youtube_url_here', data_type='youtube_video')
+```
@@ -0,0 +1,68 @@
+---
+title: ❓ FAQs
+description: 'Collections of all the frequently asked questions'
+---
+
+#### How to use GPT-4 as the LLM model?
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+# load llm configuration from gpt4.yaml file
+app = App.from_config(yaml_path="gpt4.yaml")
+```
+
+```yaml gpt4.yaml
+llm:
+  provider: openai
+  model: 'gpt-4'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+
+</CodeGroup>
+
+#### I don't have OpenAI credits. How can I use some open source model?
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+# load llm configuration from opensource.yaml file
+app = App.from_config(yaml_path="opensource.yaml")
+```
+
+```yaml opensource.yaml
+llm:
+  provider: gpt4all
+  model: 'orca-mini-3b.ggmlv3.q4_0.bin'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+
+embedder:
+  provider: gpt4all
+  config:
+    model: 'all-MiniLM-L6-v2'
+```
+</CodeGroup>
+
+#### How to contact support?
+
+If docs aren't sufficient, please feel free to reach out to us using one of the following methods:
+
+<Snippet file="get-help.mdx" />
@@ -0,0 +1,55 @@
+---
+title: 📚 Introduction
+description: '📝 Embedchain is a Data Platform for LLMs - load, index, retrieve, and sync any unstructured data'
+---
+
+## 🤔 What is Embedchain?
+
+Embedchain abstracts the entire process of loading data, chunking it, creating embeddings, and storing it in a vector database.
+
+You can add data from different data sources using the `.add()` method. Then, simply use the `.query()` method to find answers from the added datasets.
+
+If you want to create a Naval Ravikant bot with a YouTube video, a book in PDF format, two blog posts, and a question and answer pair, all you need to do is add the respective links. Embedchain will take care of the rest, creating a bot for you.
+
+```python
+from embedchain import App
+
+naval_bot = App()
+# Add online data
+naval_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44")
+naval_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf")
+naval_bot.add("https://nav.al/feedback")
+naval_bot.add("https://nav.al/agi")
+naval_bot.add("The Meanings of Life", 'text', metadata={'chapter': 'philosphy'})
+
+# Add local resources
+naval_bot.add(("Who is Naval Ravikant?", "Naval Ravikant is an Indian-American entrepreneur and investor."))
+
+naval_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?")
+# Answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
+```
+
+## 🚀 How it works?
+
+Embedchain abstracts out the following steps from you to easily create LLM powered apps:
+
+1. Detect the data type and load data
+2. Create meaningful chunks
+3. Create embeddings for each chunk
+4. Store chunks in a vector database
+
+When a user asks a query, the following process happens to find the answer:
+
+1. Create an embedding for the query
+2. Find similar documents for the query from the vector database
+3. Pass the similar documents as context to LLM to get the final answer
+
+The process of loading the dataset and querying involves multiple steps, each with its own nuances:
+
+- How should I chunk the data? What is a meaningful chunk size?
+- How should I create embeddings for each chunk? Which embedding model should I use?
+- How should I store the chunks in a vector database? Which vector database should I use?
+- Should I store metadata along with the embeddings?
+- How should I find similar documents for a query? Which ranking model should I use?
+
+Embedchain takes care of all these nuances and provides a simple interface to create apps on any data.
@@ -0,0 +1,58 @@
+---
+title: '🚀 Quickstart'
+description: '💡 Start building LLM powered apps under 30 seconds'
+---
+
+Embedchain is a Data Platform for LLMs - load, index, retrieve, and sync any unstructured data. Using embedchain, you can easily create LLM powered apps over any data. 
+
+Install embedchain python package:
+
+```bash
+pip install embedchain
+```
+
+Creating an app involves 3 steps:
+
+<Steps>
+  <Step title="⚙️ Import app instance">
+```python
+from embedchain import App
+app = App()
+```
+  </Step>
+  <Step title="🗃️ Add data sources">
+```python
+# Add different data sources
+elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
+elon_bot.add("https://www.forbes.com/profile/elon-musk")
+# You can also add local data sources such as pdf, csv files etc.
+# elon_bot.add("/path/to/file.pdf")
+```
+  </Step>
+  <Step title="💬 Query or chat on your data and get answers">
+```python
+elon_bot.query("What is the net worth of Elon Musk today?")
+# Answer: The net worth of Elon Musk today is $258.7 billion.
+```
+  </Step>
+</Steps>
+
+Putting it together, you can run your first app using the following code. Make sure to set the `OPENAI_API_KEY` 🔑 environment variable in the code.
+
+```python
+import os
+from embedchain import App
+
+os.environ["OPENAI_API_KEY"] = "xxx"
+elon_bot = App()
+
+# Add different data sources
+elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
+elon_bot.add("https://www.forbes.com/profile/elon-musk")
+# You can also add local data sources such as pdf, csv files etc.
+# elon_bot.add("/path/to/file.pdf")
+
+response = elon_bot.query("What is the net worth of Elon Musk today?")
+print(response)
+# Answer: The net worth of Elon Musk today is $258.7 billion.
+```
@@ -1,60 +0,0 @@
---
-title: 📚 Introduction
-description: '📝 Embedchain is a framework to easily create LLM powered bots over any dataset.'
---
-
-## 🤔 What is Embedchain?
-
-Embedchain abstracts the entire process of loading a dataset, chunking it, creating embeddings, and storing it in a vector database.
-
-You can add a single or multiple datasets using the `.add` method. Then, simply use the `.query` method to find answers from the added datasets.
-
-If you want to create a Naval Ravikant bot with a YouTube video, a book in PDF format, two blog posts, and a question and answer pair, all you need to do is add the respective links. Embedchain will take care of the rest, creating a bot for you.
-
-```python
-from embedchain import App
-
-naval_chat_bot = App()
-# Embed Online Resources
-naval_chat_bot.add("https://www.youtube.com/watch?v=3qHkcs3kG44")
-naval_chat_bot.add("https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf")
-naval_chat_bot.add("https://nav.al/feedback")
-naval_chat_bot.add("https://nav.al/agi")
-naval_chat_bot.add("The Meanings of Life", 'text', metadata={'chapter': 'philosphy'})
-
-# Embed Local Resources
-naval_chat_bot.add(("Who is Naval Ravikant?", "Naval Ravikant is an Indian-American entrepreneur and investor."))
-
-naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?")
-# Answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
-
-# with where context filter
-naval_chat_bot.query("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?", where={'chapter': 'philosophy'})
-```
-
-## 🚀 How it works?
-
-Creating a chat bot over any dataset involves the following steps:
-
-1. Detect the data type and load the data
-2. Create meaningful chunks
-3. Create embeddings for each chunk
-4. Store the chunks in a vector database
-
-When a user asks a query, the following process happens to find the answer:
-
-1. Create an embedding for the query
-2. Find similar documents for the query from the vector database
-3. Pass the similar documents as context to LLM to get the final answer.
-
-The process of loading the dataset and querying involves multiple steps, each with its own nuances:
-
- How should I chunk the data? What is a meaningful chunk size?
- How should I create embeddings for each chunk? Which embedding model should I use?
- How should I store the chunks in a vector database? Which vector database should I use?
- Should I store metadata along with the embeddings?
- How should I find similar documents for a query? Which ranking model should I use?
-
-Embedchain takes care of all these nuances and provides a simple interface to create bots over any dataset.
-
-In the first release, we make it easier for anyone to get a chatbot over any dataset up and running in less than a minute. Just create an app instance, add the datasets using the `.add` method, and use the `.query` method to get the relevant answers.
@@ -16,13 +16,13 @@
      "name": "Twitter",
      "url": "https://twitter.com/embedchain"
    },
-    {
-      "name": "Discord",
-      "url": "https://discord.gg/6PzXDgEjG5"
-    },
    {
      "name":"Slack",
      "url":"https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw"
+    },
+    {
+      "name": "Discord",
+      "url": "https://discord.gg/6PzXDgEjG5"
    }
  ],
  "topbarCtaButton": {
@@ -31,34 +31,83 @@
  },
  "navigation": [
    {
-      "group": "Getting started",
-      "pages": ["quickstart", "introduction"]
+      "group": "Get started",
+      "pages": ["get-started/quickstart", "get-started/introduction", "get-started/faq"]
+    },
+    {
+      "group": "Components",
+      "pages": ["components/llms", "components/embedding-models", "components/vector-databases"]
+    },
+    {
+      "group": "Data sources",
+      "pages": [
+        "data-sources/overview",
+        {
+          "group": "Supported data sources",
+          "pages": [
+            "data-sources/csv",
+            "data-sources/docs-site",
+            "data-sources/docx",
+            "data-sources/mdx",
+            "data-sources/notion",
+            "data-sources/pdf-file",
+            "data-sources/qna",
+            "data-sources/sitemap",
+            "data-sources/text",
+            "data-sources/web-page",
+            "data-sources/youtube-video"
+          ]
+        },
+        "data-sources/data-type-handling"
+      ]
    },
    {
      "group": "Advanced",
-      "pages": ["advanced/app_types", "advanced/interface_types", "advanced/adding_data", "advanced/data_types", "advanced/query_configuration", "advanced/configuration", "advanced/testing", "advanced/vector_database", "advanced/showcase"]
+      "pages": ["advanced/configuration"]
    },
    {
      "group": "Examples",
      "pages": ["examples/full_stack", "examples/api_server", "examples/discord_bot", "examples/slack_bot", "examples/telegram_bot", "examples/whatsapp_bot", "examples/poe_bot"]
    },
    {
-      "group": "Integration",
+      "group": "Community",
+      "pages": [
+        "community/connect-with-us",
+        "community/showcase"
+      ]
+    },
+    {
+      "group": "Integrations",
      "pages": ["integration/langsmith"]
    },
    {
-      "group": "Contribution Guidelines",
-      "pages": ["contribution/dev", "contribution/docs"]
+      "group": "Contribute",
+      "pages": [
+        "contribution/guidelines",
+        "contribution/dev",
+        "contribution/docs",
+        "contribution/python",
+        "contribution/javascript"
+      ]
+    },
+    {
+      "group": "Product",
+      "pages": [
+        "product/release-notes"
+      ]
    }

  ],
+
  "footerSocials": {
-    "twitter": "https://twitter.com/embedchain",
-    "github": "https://github.com/embedchain/embedchain",
-    "linkedin": "https://www.linkedin.com/company/embedchain",
    "website": "https://embedchain.ai",
-    "slack":"https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw"
+    "github": "https://github.com/embedchain/embedchain",
+    "slack":"https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw",
+    "discord": "https://discord.gg/6PzXDgEjG5",
+    "twitter": "https://twitter.com/embedchain",
+    "linkedin": "https://www.linkedin.com/company/embedchain"
  },
  "backgroundImage": "/background.png",
-  "isWhiteLabeled": true
+  "isWhiteLabeled": true,
+  "feedback.thumbsRating": true
 }
@@ -0,0 +1,4 @@
+---
+title: ' 📜 Release Notes'
+url: https://github.com/embedchain/embedchain/releases
+---
@@ -1,35 +0,0 @@
---
-title: '🚀 Quickstart'
-description: '💡 Start building LLM powered bots under 30 seconds'
---
-
-Install embedchain python package:
-
-```bash
-pip install --upgrade embedchain
-```
-
-Creating a chatbot involves 3 steps:
-
- ⚙️ Import the App instance
- 🗃️ Add Dataset
- 💬 Query or Chat on the dataset and get answers (Interface Types)
-
-Run your first bot in python using the following code. Make sure to set the `OPENAI_API_KEY` 🔑 environment variable in the code.
-
-```python
-import os
-
-from embedchain import App
-
-os.environ["OPENAI_API_KEY"] = "xxx"
-elon_musk_bot = App()
-
-# Embed Online Resources
-elon_musk_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
-elon_musk_bot.add("https://www.forbes.com/profile/elon-musk")
-
-response = elon_musk_bot.query("How many companies does Elon Musk run and name those?")
-print(response)
-# Answer: 'Elon Musk currently runs several companies. As of my knowledge, he is the CEO and lead designer of SpaceX, the CEO and product architect of Tesla, Inc., the CEO and founder of Neuralink, and the CEO and founder of The Boring Company. However, please note that this information may change over time, so it's always good to verify the latest updates.'
-```
@@ -6,6 +6,6 @@ from embedchain.apps.app import App  # noqa: F401
 from embedchain.apps.custom_app import CustomApp  # noqa: F401
 from embedchain.apps.Llama2App import Llama2App  # noqa: F401
 from embedchain.apps.open_source_app import OpenSourceApp  # noqa: F401
-from embedchain.apps.PersonApp import (PersonApp,  # noqa: F401
-                                       PersonOpenSourceApp)
+from embedchain.apps.person_app import (PersonApp,  # noqa: F401
+                                        PersonOpenSourceApp)
 from embedchain.vectordb.chroma import ChromaDB  # noqa: F401
@@ -1,15 +1,14 @@
+import logging
 from typing import Optional

-from embedchain.apps.custom_app import CustomApp
+from embedchain.apps.app import App
 from embedchain.config import CustomAppConfig
-from embedchain.embedder.openai import OpenAIEmbedder
 from embedchain.helper.json_serializable import register_deserializable
 from embedchain.llm.llama2 import Llama2Llm
-from embedchain.vectordb.chroma import ChromaDB


@register_deserializable
-class Llama2App(CustomApp):
+class Llama2App(App):
    """
    The EmbedChain Llama2App class.

@@ -17,17 +16,23 @@ class Llama2App(CustomApp):
    add(source, data_type): adds the data from the given URL to the vector db.
    query(query): finds answer to the given query using vector database and LLM.
    chat(query): finds answer to the given query using vector database and LLM, with conversation history.
+
+    .. deprecated:: 0.0.64
+    Use `App` instead.
    """

    def __init__(self, config: CustomAppConfig = None, system_prompt: Optional[str] = None):
        """
+        .. deprecated:: 0.0.64
+        Use `App` instead.
+
        :param config: CustomAppConfig instance to load as configuration. Optional.
        :param system_prompt: System prompt string. Optional.
        """
-
-        if config is None:
-            config = CustomAppConfig()
-
-        super().__init__(
-            config=config, llm=Llama2Llm(), db=ChromaDB(), embedder=OpenAIEmbedder(), system_prompt=system_prompt
+        logging.warning(
+            "DEPRECATION WARNING: Please use `App` instead of `Llama2App`. "
+            "`Llama2App` will be removed in a future release. "
+            "Please refer to https://docs.embedchain.ai/advanced/app_types#llama2app for instructions."
        )
+
+        super().__init__(config=config, llm=Llama2Llm(), system_prompt=system_prompt)
@@ -1,11 +1,17 @@
 from typing import Optional

-from embedchain.config import (AppConfig, BaseEmbedderConfig, BaseLlmConfig,
-                               ChromaDbConfig)
+import yaml
+
+from embedchain.config import AppConfig, BaseEmbedderConfig, BaseLlmConfig
+from embedchain.config.vectordb.base import BaseVectorDbConfig
 from embedchain.embedchain import EmbedChain
+from embedchain.embedder.base import BaseEmbedder
 from embedchain.embedder.openai import OpenAIEmbedder
+from embedchain.factory import EmbedderFactory, LlmFactory, VectorDBFactory
 from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.base import BaseLlm
 from embedchain.llm.openai import OpenAILlm
+from embedchain.vectordb.base import BaseVectorDB
 from embedchain.vectordb.chroma import ChromaDB


@@ -23,32 +29,117 @@ class App(EmbedChain):

    def __init__(
        self,
-        config: AppConfig = None,
-        llm_config: BaseLlmConfig = None,
-        chromadb_config: Optional[ChromaDbConfig] = None,
+        config: Optional[AppConfig] = None,
+        llm: BaseLlm = None,
+        llm_config: Optional[BaseLlmConfig] = None,
+        db: BaseVectorDB = None,
+        db_config: Optional[BaseVectorDbConfig] = None,
+        embedder: BaseEmbedder = None,
+        embedder_config: Optional[BaseEmbedderConfig] = None,
        system_prompt: Optional[str] = None,
    ):
        """
-        Initialize a new `CustomApp` instance. You only have a few choices to make.
+        Initialize a new `App` instance.

-        :param config: Config for the app instance.
-        This is the most basic configuration, that does not fall into the LLM, database or embedder category,
-        defaults to None
-        :type config: AppConfig, optional
+        :param config: Config for the app instance., defaults to None
+        :type config: Optional[AppConfig], optional
+        :param llm:  LLM Class instance. example: `from embedchain.llm.openai import OpenAILlm`, defaults to OpenAiLlm
+        :type llm: BaseLlm, optional
        :param llm_config: Allows you to configure the LLM, e.g. how many documents to return,
-        example: `from embedchain.config import LlmConfig`, defaults to None
-        :type llm_config: BaseLlmConfig, optional
-        :param chromadb_config: Allows you to configure the vector database,
+        example: `from embedchain.config import BaseLlmConfig`, defaults to None
+        :type llm_config: Optional[BaseLlmConfig], optional
+        :param db: The database to use for storing and retrieving embeddings,
+        example: `from embedchain.vectordb.chroma_db import ChromaDb`, defaults to ChromaDb
+        :type db: BaseVectorDB, optional
+        :param db_config: Allows you to configure the vector database,
        example: `from embedchain.config import ChromaDbConfig`, defaults to None
-        :type chromadb_config: Optional[ChromaDbConfig], optional
+        :type db_config: Optional[BaseVectorDbConfig], optional
+        :param embedder: The embedder (embedding model and function) use to calculate embeddings.
+        example: `from embedchain.embedder.gpt4all_embedder import GPT4AllEmbedder`, defaults to OpenAIEmbedder
+        :type embedder: BaseEmbedder, optional
+        :param embedder_config: Allows you to configure the Embedder.
+        example: `from embedchain.config import BaseEmbedderConfig`, defaults to None
+        :type embedder_config: Optional[BaseEmbedderConfig], optional
        :param system_prompt: System prompt that will be provided to the LLM as such, defaults to None
        :type system_prompt: Optional[str], optional
+        :raises TypeError: LLM, database or embedder or their config is not a valid class instance.
        """
+        # Type check configs
+        if config and not isinstance(config, AppConfig):
+            raise TypeError(
+                "Config is not a `AppConfig` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        if llm_config and not isinstance(llm_config, BaseLlmConfig):
+            raise TypeError(
+                "`llm_config` is not a `BaseLlmConfig` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        if db_config and not isinstance(db_config, BaseVectorDbConfig):
+            raise TypeError(
+                "`db_config` is not a `BaseVectorDbConfig` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        if embedder_config and not isinstance(embedder_config, BaseEmbedderConfig):
+            raise TypeError(
+                "`embedder_config` is not a `BaseEmbedderConfig` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+
+        # Assign defaults
        if config is None:
            config = AppConfig()
+        if llm is None:
+            llm = OpenAILlm(config=llm_config)
+        if db is None:
+            db = ChromaDB(config=db_config)
+        if embedder is None:
+            embedder = OpenAIEmbedder(config=embedder_config)

-        llm = OpenAILlm(config=llm_config)
-        embedder = OpenAIEmbedder(config=BaseEmbedderConfig(model="text-embedding-ada-002"))
-        database = ChromaDB(config=chromadb_config)
+        # Type check assignments
+        if not isinstance(llm, BaseLlm):
+            raise TypeError(
+                "LLM is not a `BaseLlm` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        if not isinstance(db, BaseVectorDB):
+            raise TypeError(
+                "Database is not a `BaseVectorDB` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        if not isinstance(embedder, BaseEmbedder):
+            raise TypeError(
+                "Embedder is not a `BaseEmbedder` instance. "
+                "Please make sure the type is right and that you are passing an instance."
+            )
+        super().__init__(config, llm=llm, db=db, embedder=embedder, system_prompt=system_prompt)

-        super().__init__(config, llm, db=database, embedder=embedder, system_prompt=system_prompt)
+    @classmethod
+    def from_config(cls, yaml_path: str):
+        """
+        Instantiate an App object from a YAML configuration file.
+
+        :param yaml_path: Path to the YAML configuration file.
+        :type yaml_path: str
+        :return: An instance of the App class.
+        :rtype: App
+        """
+        with open(yaml_path, "r") as file:
+            config_data = yaml.safe_load(file)
+
+        app_config_data = config_data.get("app", {})
+        llm_config_data = config_data.get("llm", {})
+        db_config_data = config_data.get("vectordb", {})
+        embedder_config_data = config_data.get("embedder", {})
+
+        app_config = AppConfig(**app_config_data.get("config", {}))
+
+        llm_provider = llm_config_data.get("provider", "openai")
+        llm = LlmFactory.create(llm_provider, llm_config_data.get("config", {}))
+
+        db_provider = db_config_data.get("provider", "chroma")
+        db = VectorDBFactory.create(db_provider, db_config_data.get("config", {}))
+
+        embedder_provider = embedder_config_data.get("provider", "openai")
+        embedder = EmbedderFactory.create(embedder_provider, embedder_config_data.get("config", {}))
+        return cls(config=app_config, llm=llm, db=db, embedder=embedder)
@@ -1,7 +1,8 @@
+import logging
 from typing import Optional

+from embedchain.apps.app import App
 from embedchain.config import CustomAppConfig
-from embedchain.embedchain import EmbedChain
 from embedchain.embedder.base import BaseEmbedder
 from embedchain.helper.json_serializable import register_deserializable
 from embedchain.llm.base import BaseLlm
@@ -9,7 +10,7 @@ from embedchain.vectordb.base import BaseVectorDB


@register_deserializable
-class CustomApp(EmbedChain):
+class CustomApp(App):
    """
    Embedchain's custom app allows for most flexibility.

@@ -19,6 +20,9 @@ class CustomApp(EmbedChain):
    add(source, data_type): adds the data from the given URL to the vector db.
    query(query): finds answer to the given query using vector database and LLM.
    chat(query): finds answer to the given query using vector database and LLM, with conversation history.
+
+    .. deprecated:: 0.0.64
+        Use `App` instead.
    """

    def __init__(
@@ -32,6 +36,9 @@ class CustomApp(EmbedChain):
        """
        Initialize a new `CustomApp` instance. You have to choose a LLM, database and embedder.

+        .. deprecated:: 0.0.64
+        Use `App` instead.
+
        :param config: Config for the app instance. This is the most basic configuration,
        that does not fall into the LLM, database or embedder category, defaults to None
        :type config: Optional[CustomAppConfig], optional
@@ -48,36 +55,9 @@ class CustomApp(EmbedChain):
        :raises ValueError: LLM, database or embedder has not been defined.
        :raises TypeError: LLM, database or embedder is not a valid class instance.
        """
-        # Config is not required, it has a default
-        if config is None:
-            config = CustomAppConfig()
-
-        if llm is None:
-            raise ValueError("LLM must be provided for custom app. Please import from `embedchain.llm`.")
-        if db is None:
-            raise ValueError("Database must be provided for custom app. Please import from `embedchain.vectordb`.")
-        if embedder is None:
-            raise ValueError("Embedder must be provided for custom app. Please import from `embedchain.embedder`.")
-
-        if not isinstance(config, CustomAppConfig):
-            raise TypeError(
-                "Config is not a `CustomAppConfig` instance. "
-                "Please make sure the type is right and that you are passing an instance."
-            )
-        if not isinstance(llm, BaseLlm):
-            raise TypeError(
-                "LLM is not a `BaseLlm` instance. "
-                "Please make sure the type is right and that you are passing an instance."
-            )
-        if not isinstance(db, BaseVectorDB):
-            raise TypeError(
-                "Database is not a `BaseVectorDB` instance. "
-                "Please make sure the type is right and that you are passing an instance."
-            )
-        if not isinstance(embedder, BaseEmbedder):
-            raise TypeError(
-                "Embedder is not a `BaseEmbedder` instance. "
-                "Please make sure the type is right and that you are passing an instance."
-            )
-
+        logging.warning(
+            "DEPRECATION WARNING: Please use `App` instead of `CustomApp`. "
+            "`CustomApp` will be removed in a future release. "
+            "Please refer to https://docs.embedchain.ai/advanced/app_types#opensourceapp for instructions."
+        )
        super().__init__(config=config, llm=llm, db=db, embedder=embedder, system_prompt=system_prompt)
@@ -1,9 +1,9 @@
 import logging
 from typing import Optional

-from embedchain.config import (BaseEmbedderConfig, BaseLlmConfig,
-                               ChromaDbConfig, OpenSourceAppConfig)
-from embedchain.embedchain import EmbedChain
+from embedchain.apps.app import App
+from embedchain.config import (BaseLlmConfig, ChromaDbConfig,
+                               OpenSourceAppConfig)
 from embedchain.embedder.gpt4all import GPT4AllEmbedder
 from embedchain.helper.json_serializable import register_deserializable
 from embedchain.llm.gpt4all import GPT4ALLLlm
@@ -13,7 +13,7 @@ gpt4all_model = None


@register_deserializable
-class OpenSourceApp(EmbedChain):
+class OpenSourceApp(App):
    """
    The embedchain Open Source App.
    Comes preconfigured with the best open source LLM, embedding model, database.
@@ -22,6 +22,9 @@ class OpenSourceApp(EmbedChain):
    add(source, data_type): adds the data from the given URL to the vector db.
    query(query): finds answer to the given query using vector database and LLM.
    chat(query): finds answer to the given query using vector database and LLM, with conversation history.
+
+    .. deprecated:: 0.0.64
+    Use `App` instead.
    """

    def __init__(
@@ -36,11 +39,14 @@ class OpenSourceApp(EmbedChain):
        Since it's opinionated you don't have to choose a LLM, database and embedder.
        However, you can configure those.

+        .. deprecated:: 0.0.64
+        Use `App` instead.
+
        :param config: Config for the app instance. This is the most basic configuration,
        that does not fall into the LLM, database or embedder category, defaults to None
        :type config: OpenSourceAppConfig, optional
        :param llm_config: Allows you to configure the LLM, e.g. how many documents to return.
-        example: `from embedchain.config import LlmConfig`, defaults to None
+        example: `from embedchain.config import BaseLlmConfig`, defaults to None
        :type llm_config: BaseLlmConfig, optional
        :param chromadb_config: Allows you to configure the open source database,
        example: `from embedchain.config import ChromaDbConfig`, defaults to None
@@ -48,31 +54,18 @@ class OpenSourceApp(EmbedChain):
        :param system_prompt: System prompt that will be provided to the LLM as such.
        Please don't use for the time being, as it's not supported., defaults to None
        :type system_prompt: Optional[str], optional
-        :raises TypeError: `OpenSourceAppConfig` or `LlmConfig` invalid.
+        :raises TypeError: `OpenSourceAppConfig` or `BaseLlmConfig` invalid.
        """
-        logging.info("Loading open source embedding model. This may take some time...")  # noqa:E501
-        if not config:
-            config = OpenSourceAppConfig()
+        logging.warning(
+            "DEPRECATION WARNING: Please use `App` instead of `OpenSourceApp`."
+            "`OpenSourceApp` will be removed in a future release."
+            "Please refer to https://docs.embedchain.ai/advanced/app_types#customapp for instructions."
+        )

-        if not isinstance(config, OpenSourceAppConfig):
-            raise TypeError(
-                "OpenSourceApp needs a OpenSourceAppConfig passed to it. "
-                "You can import it with `from embedchain.config import OpenSourceAppConfig`"
-            )
-
-        if not llm_config:
-            llm_config = BaseLlmConfig(model="orca-mini-3b.ggmlv3.q4_0.bin")
-        elif not isinstance(llm_config, BaseLlmConfig):
-            raise TypeError(
-                "The LlmConfig passed to OpenSourceApp is invalid. "
-                "You can import it with `from embedchain.config import LlmConfig`"
-            )
-        elif not llm_config.model:
-            llm_config.model = "orca-mini-3b.ggmlv3.q4_0.bin"
-
-        llm = GPT4ALLLlm(config=llm_config)
-        embedder = GPT4AllEmbedder(config=BaseEmbedderConfig(model="all-MiniLM-L6-v2"))
-        logging.error("Successfully loaded open source embedding model.")
-        database = ChromaDB(config=chromadb_config)
-
-        super().__init__(config, llm=llm, db=database, embedder=embedder, system_prompt=system_prompt)
+        super().__init__(
+            config=config,
+            llm=GPT4ALLLlm(config=llm_config),
+            db=ChromaDB(config=chromadb_config),
+            embedder=GPT4AllEmbedder(),
+            system_prompt=system_prompt,
+        )
@@ -2,10 +2,9 @@ from string import Template

 from embedchain.apps.app import App
 from embedchain.apps.open_source_app import OpenSourceApp
-from embedchain.config import BaseLlmConfig
-from embedchain.config.apps.base_app_config import BaseAppConfig
-from embedchain.config.llm.base_llm_config import (DEFAULT_PROMPT,
-                                                   DEFAULT_PROMPT_WITH_HISTORY)
+from embedchain.config import AppConfig, BaseLlmConfig
+from embedchain.config.llm.base import (DEFAULT_PROMPT,
+                                        DEFAULT_PROMPT_WITH_HISTORY)
 from embedchain.helper.json_serializable import register_deserializable


@@ -16,16 +15,16 @@ class EmbedChainPersonApp:
    This bot behaves and speaks like a person.

    :param person: name of the person, better if its a well known person.
-    :param config: BaseAppConfig instance to load as configuration.
+    :param config: AppConfig instance to load as configuration.
    """

-    def __init__(self, person: str, config: BaseAppConfig = None):
+    def __init__(self, person: str, config: AppConfig = None):
        """Initialize a new person app

        :param person: Name of the person that's imitated.
        :type person: str
        :param config: Configuration class instance, defaults to None
-        :type config: BaseAppConfig, optional
+        :type config: AppConfig, optional
        """
        self.person = person
        self.person_prompt = f"You are {person}. Whatever you say, you will always say in {person} style."  # noqa:E501
@@ -70,7 +69,7 @@ class PersonApp(EmbedChainPersonApp, App):
    """

    def query(self, input_query, config: BaseLlmConfig = None, dry_run=False):
-        config = self.add_person_template_to_config(DEFAULT_PROMPT, config, where=None)
+        config = self.add_person_template_to_config(DEFAULT_PROMPT, config)
        return super().query(input_query, config, dry_run, where=None)

    def chat(self, input_query, config: BaseLlmConfig = None, dry_run=False, where=None):
@@ -1,7 +1,7 @@
 from typing import Any

-from embedchain import CustomApp
-from embedchain.config import AddConfig, CustomAppConfig, LlmConfig
+from embedchain import App
+from embedchain.config import AddConfig, AppConfig, BaseLlmConfig
 from embedchain.embedder.openai import OpenAIEmbedder
 from embedchain.helper.json_serializable import (JSONSerializable,
                                                 register_deserializable)
@@ -12,7 +12,7 @@ from embedchain.vectordb.chroma import ChromaDB
@register_deserializable
 class BaseBot(JSONSerializable):
    def __init__(self):
-        self.app = CustomApp(config=CustomAppConfig(), llm=OpenAILlm(), db=ChromaDB(), embedder=OpenAIEmbedder())
+        self.app = App(config=AppConfig(), llm=OpenAILlm(), db=ChromaDB(), embedder=OpenAIEmbedder())

    def add(self, data: Any, config: AddConfig = None):
        """
@@ -27,14 +27,14 @@ class BaseBot(JSONSerializable):
        config = config if config else AddConfig()
        self.app.add(data, config=config)

-    def query(self, query: str, config: LlmConfig = None) -> str:
+    def query(self, query: str, config: BaseLlmConfig = None) -> str:
        """
        Query the bot

        :param query: the user query
        :type query: str
        :param config: configuration class instance, defaults to None
-        :type config: LlmConfig, optional
+        :type config: BaseLlmConfig, optional
        :return: Answer
        :rtype: str
        """
@@ -10,7 +10,7 @@ class BaseChunker(JSONSerializable):
        self.text_splitter = text_splitter
        self.data_type = None

-    def create_chunks(self, loader, src):
+    def create_chunks(self, loader, src, app_id=None):
        """
        Loads data and chunks it.

@@ -18,13 +18,18 @@ class BaseChunker(JSONSerializable):
        the raw data.
        :param src: The data to be handled by the loader. Can be a URL for
        remote sources or local content for local loaders.
+        :param app_id: App id used to generate the doc_id.
        """
        documents = []
-        ids = []
+        chunk_ids = []
        idMap = {}
        data_result = loader.load_data(src)
        data_records = data_result["data"]
        doc_id = data_result["doc_id"]
+        # Prefix app_id in the document id if app_id is not None to
+        # distinguish between different documents stored in the same
+        # elasticsearch or opensearch index
+        doc_id = f"{app_id}--{doc_id}" if app_id is not None else doc_id
        metadatas = []
        for data in data_records:
            content = data["content"]
@@ -41,12 +46,12 @@ class BaseChunker(JSONSerializable):
                chunk_id = hashlib.sha256((chunk + url).encode()).hexdigest()
                if idMap.get(chunk_id) is None:
                    idMap[chunk_id] = True
-                    ids.append(chunk_id)
+                    chunk_ids.append(chunk_id)
                    documents.append(chunk)
                    metadatas.append(meta_data)
        return {
            "documents": documents,
-            "ids": ids,
+            "ids": chunk_ids,
            "metadatas": metadatas,
            "doc_id": doc_id,
        }
@@ -66,3 +71,6 @@ class BaseChunker(JSONSerializable):
        self.data_type = data_type

        # TODO: This should be done during initialization. This means it has to be done in the child classes.
+
+    def get_word_count(self, documents):
+        return sum([len(document.split(" ")) for document in documents])
@@ -0,0 +1,64 @@
+import hashlib
+from typing import Optional
+
+from langchain.text_splitter import RecursiveCharacterTextSplitter
+
+from embedchain.chunkers.base_chunker import BaseChunker
+from embedchain.config.add_config import ChunkerConfig
+
+
+class ImagesChunker(BaseChunker):
+    """Chunker for an Image."""
+
+    def __init__(self, config: Optional[ChunkerConfig] = None):
+        if config is None:
+            config = ChunkerConfig(chunk_size=300, chunk_overlap=0, length_function=len)
+        image_splitter = RecursiveCharacterTextSplitter(
+            chunk_size=config.chunk_size,
+            chunk_overlap=config.chunk_overlap,
+            length_function=config.length_function,
+        )
+        super().__init__(image_splitter)
+
+    def create_chunks(self, loader, src, app_id=None):
+        """
+        Loads the image(s), and creates their corresponding embedding. This creates one chunk for each image
+
+        :param loader: The loader whose `load_data` method is used to create
+        the raw data.
+        :param src: The data to be handled by the loader. Can be a URL for
+        remote sources or local content for local loaders.
+        """
+        documents = []
+        embeddings = []
+        ids = []
+        data_result = loader.load_data(src)
+        data_records = data_result["data"]
+        doc_id = data_result["doc_id"]
+        doc_id = f"{app_id}--{doc_id}" if app_id is not None else doc_id
+        metadatas = []
+        for data in data_records:
+            meta_data = data["meta_data"]
+            # add data type to meta data to allow query using data type
+            meta_data["data_type"] = self.data_type.value
+            chunk_id = hashlib.sha256(meta_data["url"].encode()).hexdigest()
+            ids.append(chunk_id)
+            documents.append(data["content"])
+            embeddings.append(data["embedding"])
+            meta_data["doc_id"] = doc_id
+            metadatas.append(meta_data)
+
+        return {
+            "documents": documents,
+            "embeddings": embeddings,
+            "ids": ids,
+            "metadatas": metadatas,
+            "doc_id": doc_id,
+        }
+
+    def get_word_count(self, documents):
+        """
+        The number of chunks and the corresponding word count for an image is fixed to 1, as 1 embedding is created for
+        each image
+        """
+        return 1
@@ -0,0 +1,22 @@
+from typing import Optional
+
+from langchain.text_splitter import RecursiveCharacterTextSplitter
+
+from embedchain.chunkers.base_chunker import BaseChunker
+from embedchain.config.add_config import ChunkerConfig
+from embedchain.helper.json_serializable import register_deserializable
+
+
+@register_deserializable
+class SitemapChunker(BaseChunker):
+    """Chunker for sitemap."""
+
+    def __init__(self, config: Optional[ChunkerConfig] = None):
+        if config is None:
+            config = ChunkerConfig(chunk_size=500, chunk_overlap=0, length_function=len)
+        text_splitter = RecursiveCharacterTextSplitter(
+            chunk_size=config.chunk_size,
+            chunk_overlap=config.chunk_overlap,
+            length_function=config.length_function,
+        )
+        super().__init__(text_splitter)
@@ -0,0 +1,22 @@
+from typing import Optional
+
+from langchain.text_splitter import RecursiveCharacterTextSplitter
+
+from embedchain.chunkers.base_chunker import BaseChunker
+from embedchain.config.add_config import ChunkerConfig
+from embedchain.helper.json_serializable import register_deserializable
+
+
+@register_deserializable
+class XmlChunker(BaseChunker):
+    """Chunker for XML files."""
+
+    def __init__(self, config: Optional[ChunkerConfig] = None):
+        if config is None:
+            config = ChunkerConfig(chunk_size=500, chunk_overlap=50, length_function=len)
+        text_splitter = RecursiveCharacterTextSplitter(
+            chunk_size=config.chunk_size,
+            chunk_overlap=config.chunk_overlap,
+            length_function=config.length_function,
+        )
+        super().__init__(text_splitter)
@@ -7,8 +7,8 @@ from .apps.open_source_app_config import OpenSourceAppConfig
 from .base_config import BaseConfig
 from .embedder.base import BaseEmbedderConfig
 from .embedder.base import BaseEmbedderConfig as EmbedderConfig
-from .llm.base_llm_config import BaseLlmConfig
-from .llm.base_llm_config import BaseLlmConfig as LlmConfig
+from .llm.base import BaseLlmConfig
 from .vectordb.chroma import ChromaDbConfig
 from .vectordb.elasticsearch import ElasticsearchDBConfig
 from .vectordb.opensearch import OpenSearchDBConfig
+from .vectordb.zilliz import ZillizDBConfig
@@ -67,12 +67,12 @@ class BaseLlmConfig(BaseConfig):
        deployment_name: Optional[str] = None,
        system_prompt: Optional[str] = None,
        where: Dict[str, Any] = None,
+        query_type: Optional[str] = None,
    ):
        """
        Initializes a configuration class instance for the LLM.

        Takes the place of the former `QueryConfig` or `ChatConfig`.
-        Use `LlmConfig` as an alias to `BaseLlmConfig`.

        :param number_documents:  Number of documents to pull from the database as
        context, defaults to 1
@@ -112,6 +112,10 @@ class BaseLlmConfig(BaseConfig):
        self.top_p = top_p
        self.deployment_name = deployment_name
        self.system_prompt = system_prompt
+        self.query_type = query_type
+
+        if type(template) is str:
+            template = Template(template)

        if self.validate_template(template):
            self.template = template
@@ -10,6 +10,7 @@ class BaseVectorDbConfig(BaseConfig):
        dir: str = "db",
        host: Optional[str] = None,
        port: Optional[str] = None,
+        **kwargs,
    ):
        """
        Initializes a configuration class instance for the vector database.
@@ -22,8 +23,14 @@ class BaseVectorDbConfig(BaseConfig):
        :type host: Optional[str], optional
        :param host: Database connection remote port. Use this if you run Embedchain as a client, defaults to None
        :type port: Optional[str], optional
+        :param kwargs: Additional keyword arguments
+        :type kwargs: dict
        """
        self.collection_name = collection_name or "embedchain_store"
        self.dir = dir
        self.host = host
        self.port = port
+        # Assign additional keyword arguments
+        if kwargs:
+            for key, value in kwargs.items():
+                setattr(self, key, value)
@@ -0,0 +1,20 @@
+from typing import Dict, Optional
+
+from embedchain.config.vectordb.base import BaseVectorDbConfig
+from embedchain.helper.json_serializable import register_deserializable
+
+
+@register_deserializable
+class PineconeDBConfig(BaseVectorDbConfig):
+    def __init__(
+        self,
+        collection_name: Optional[str] = None,
+        dir: Optional[str] = None,
+        vector_dimension: int = 1536,
+        metric: Optional[str] = "cosine",
+        **extra_params: Dict[str, any],
+    ):
+        self.metric = metric
+        self.vector_dimension = vector_dimension
+        self.extra_params = extra_params
+        super().__init__(collection_name=collection_name, dir=dir)
@@ -0,0 +1,49 @@
+import os
+from typing import Optional
+
+from embedchain.config.vectordb.base import BaseVectorDbConfig
+from embedchain.helper.json_serializable import register_deserializable
+
+
+@register_deserializable
+class ZillizDBConfig(BaseVectorDbConfig):
+    def __init__(
+        self,
+        collection_name: Optional[str] = None,
+        dir: Optional[str] = None,
+        uri: Optional[str] = None,
+        token: Optional[str] = None,
+        vector_dim: Optional[str] = None,
+        metric_type: Optional[str] = None,
+    ):
+        """
+        Initializes a configuration class instance for the vector database.
+
+        :param collection_name: Default name for the collection, defaults to None
+        :type collection_name: Optional[str], optional
+        :param dir: Path to the database directory, where the database is stored, defaults to "db"
+        :type dir: str, optional
+        :param uri: Cluster endpoint obtained from the Zilliz Console, defaults to None
+        :type uri: Optional[str], optional
+        :param token: API Key, if a Serverless Cluster, username:password, if a Dedicated Cluster, defaults to None
+        :type port: Optional[str], optional
+        """
+        self.uri = uri or os.environ.get("ZILLIZ_CLOUD_URI")
+        if not self.uri:
+            raise AttributeError(
+                "Zilliz needs a URI attribute, "
+                "this can either be passed to `ZILLIZ_CLOUD_URI` or as `ZILLIZ_CLOUD_URI` in `.env`"
+            )
+
+        self.token = token or os.environ.get("ZILLIZ_CLOUD_TOKEN")
+        if not self.token:
+            raise AttributeError(
+                "Zilliz needs a token attribute, "
+                "this can either be passed to `ZILLIZ_CLOUD_TOKEN` or as `ZILLIZ_CLOUD_TOKEN` in `.env`,"
+                "if having a username and password, pass it in the form 'username:password' to `ZILLIZ_CLOUD_TOKEN`"
+            )
+
+        self.metric_type = metric_type if metric_type else "L2"
+
+        self.vector_dim = vector_dim
+        super().__init__(collection_name=collection_name, dir=dir)
@@ -1,13 +1,16 @@
 from embedchain.chunkers.base_chunker import BaseChunker
 from embedchain.chunkers.docs_site import DocsSiteChunker
 from embedchain.chunkers.docx_file import DocxFileChunker
+from embedchain.chunkers.images import ImagesChunker
 from embedchain.chunkers.mdx import MdxChunker
 from embedchain.chunkers.notion import NotionChunker
 from embedchain.chunkers.pdf_file import PdfFileChunker
 from embedchain.chunkers.qna_pair import QnaPairChunker
+from embedchain.chunkers.sitemap import SitemapChunker
 from embedchain.chunkers.table import TableChunker
 from embedchain.chunkers.text import TextChunker
 from embedchain.chunkers.web_page import WebPageChunker
+from embedchain.chunkers.xml import XmlChunker
 from embedchain.chunkers.youtube_video import YoutubeVideoChunker
 from embedchain.config import AddConfig
 from embedchain.config.add_config import ChunkerConfig, LoaderConfig
@@ -16,12 +19,14 @@ from embedchain.loaders.base_loader import BaseLoader
 from embedchain.loaders.csv import CsvLoader
 from embedchain.loaders.docs_site_loader import DocsSiteLoader
 from embedchain.loaders.docx_file import DocxFileLoader
+from embedchain.loaders.images import ImagesLoader
 from embedchain.loaders.local_qna_pair import LocalQnaPairLoader
 from embedchain.loaders.local_text import LocalTextLoader
 from embedchain.loaders.mdx import MdxLoader
 from embedchain.loaders.pdf_file import PdfFileLoader
 from embedchain.loaders.sitemap import SitemapLoader
 from embedchain.loaders.web_page import WebPageLoader
+from embedchain.loaders.xml import XmlLoader
 from embedchain.loaders.youtube_video import YoutubeVideoLoader
 from embedchain.models.data_type import DataType

@@ -65,9 +70,11 @@ class DataFormatter(JSONSerializable):
            DataType.TEXT: LocalTextLoader,
            DataType.DOCX: DocxFileLoader,
            DataType.SITEMAP: SitemapLoader,
+            DataType.XML: XmlLoader,
            DataType.DOCS_SITE: DocsSiteLoader,
            DataType.CSV: CsvLoader,
            DataType.MDX: MdxLoader,
+            DataType.IMAGES: ImagesLoader,
        }
        lazy_loaders = {DataType.NOTION}
        if data_type in loaders:
@@ -102,11 +109,13 @@ class DataFormatter(JSONSerializable):
            DataType.QNA_PAIR: QnaPairChunker,
            DataType.TEXT: TextChunker,
            DataType.DOCX: DocxFileChunker,
-            DataType.WEB_PAGE: WebPageChunker,
            DataType.DOCS_SITE: DocsSiteChunker,
+            DataType.SITEMAP: SitemapChunker,
            DataType.NOTION: NotionChunker,
            DataType.CSV: TableChunker,
            DataType.MDX: MdxChunker,
+            DataType.IMAGES: ImagesChunker,
+            DataType.XML: XmlChunker,
        }
        if data_type in chunker_classes:
            chunker_class: type = chunker_classes[data_type]
@@ -212,7 +212,7 @@ class EmbedChain(JSONSerializable):
        # Send anonymous telemetry
        if self.config.collect_metrics:
            # it's quicker to check the variable twice than to count words when they won't be submitted.
-            word_count = sum([len(document.split(" ")) for document in documents])
+            word_count = data_formatter.chunker.get_word_count(documents)

            extra_metadata = {"data_type": data_type.value, "word_count": word_count, "chunks_count": new_chunks}
            thread_telemetry = threading.Thread(target=self._send_telemetry_event, args=("add", extra_metadata))
@@ -268,14 +268,16 @@ class EmbedChain(JSONSerializable):
        elif chunker.data_type.value in [item.value for item in IndirectDataType]:
            # These types have a indirect source reference
            # As long as the reference is the same, they can be updated.
-            existing_embeddings_data = self.db.get(
-                where={
-                    "url": src,
-                },
+            where = {"url": src}
+            if self.config.id is not None:
+                where.update({"app_id": self.config.id})
+
+            existing_embeddings = self.db.get(
+                where=where,
                limit=1,
            )
-            if len(existing_embeddings_data.get("metadatas", [])) > 0:
-                return existing_embeddings_data["metadatas"][0]["doc_id"]
+            if len(existing_embeddings.get("metadatas", [])) > 0:
+                return existing_embeddings["metadatas"][0]["doc_id"]
            else:
                return None
        elif chunker.data_type.value in [item.value for item in SpecialDataType]:
@@ -283,14 +285,16 @@ class EmbedChain(JSONSerializable):
            # Through custom logic, they can be attributed to a source and be updated.
            if chunker.data_type == DataType.QNA_PAIR:
                # QNA_PAIRs update the answer if the question already exists.
-                existing_embeddings_data = self.db.get(
-                    where={
-                        "question": src[0],
-                    },
+                where = {"question": src[0]}
+                if self.config.id is not None:
+                    where.update({"app_id": self.config.id})
+
+                existing_embeddings = self.db.get(
+                    where=where,
                    limit=1,
                )
-                if len(existing_embeddings_data.get("metadatas", [])) > 0:
-                    return existing_embeddings_data["metadatas"][0]["doc_id"]
+                if len(existing_embeddings.get("metadatas", [])) > 0:
+                    return existing_embeddings["metadatas"][0]["doc_id"]
                else:
                    return None
            else:
@@ -326,16 +330,15 @@ class EmbedChain(JSONSerializable):
        :return: (List) documents (embedded text), (List) metadata, (list) ids, (int) number of chunks
        """
        existing_doc_id = self._get_existing_doc_id(chunker=chunker, src=src)
+        app_id = self.config.id if self.config is not None else None

        # Create chunks
-        embeddings_data = chunker.create_chunks(loader, src)
-
+        embeddings_data = chunker.create_chunks(loader, src, app_id=app_id)
        # spread chunking results
        documents = embeddings_data["documents"]
        metadatas = embeddings_data["metadatas"]
        ids = embeddings_data["ids"]
        new_doc_id = embeddings_data["doc_id"]
-
        if existing_doc_id and existing_doc_id == new_doc_id:
            print("Doc content has not changed. Skipping creating chunks and embeddings")
            return [], [], [], 0
@@ -346,12 +349,11 @@ class EmbedChain(JSONSerializable):
            self.db.delete({"doc_id": existing_doc_id})

        # get existing ids, and discard doc if any common id exist.
-        where = {"app_id": self.config.id} if self.config.id is not None else {}
-        # where={"url": src}
-        db_result = self.db.get(
-            ids=ids,
-            where=where,  # optional filter
-        )
+        where = {"url": src}
+        if self.config.id is not None:
+            where["app_id"] = self.config.id
+
+        db_result = self.db.get(ids=ids, where=where)  # optional filter
        existing_ids = set(db_result["ids"])

        if len(existing_ids):
@@ -393,8 +395,15 @@ class EmbedChain(JSONSerializable):
        # Count before, to calculate a delta in the end.
        chunks_before_addition = self.db.count()

-        self.db.add(documents=documents, metadatas=metadatas, ids=ids)
+        self.db.add(
+            embeddings=embeddings_data.get("embeddings", None),
+            documents=documents,
+            metadatas=metadatas,
+            ids=ids,
+            skip_embedding=(chunker.data_type == DataType.IMAGES),
+        )
        count_new_chunks = self.db.count() - chunks_before_addition
+
        print((f"Successfully saved {src} ({chunker.data_type}). New chunks count: {count_new_chunks}"))
        return list(documents), metadatas, ids, count_new_chunks

@@ -434,10 +443,21 @@ class EmbedChain(JSONSerializable):
        if self.config.id is not None:
            where.update({"app_id": self.config.id})

+        # We cannot query the database with the input query in case of an image search. This is because we need
+        # to bring down both the image and text to the same dimension to be able to compare them.
+        db_query = input_query
+        if hasattr(config, "query_type") and config.query_type == "Images":
+            # We import the clip processor here to make sure the package is not dependent on clip dependency even if the
+            # image dataset is not being used
+            from embedchain.models.clip_processor import ClipProcessor
+
+            db_query = ClipProcessor.get_text_features(query=input_query)
+
        contents = self.db.query(
-            input_query=input_query,
+            input_query=db_query,
            n_results=query_config.number_documents,
            where=where,
+            skip_embedding=(hasattr(config, "query_type") and config.query_type == "Images"),
        )

        return contents
@@ -450,7 +470,7 @@ class EmbedChain(JSONSerializable):

        :param input_query: The query to use.
        :type input_query: str
-        :param config: The `LlmConfig` instance to use as configuration options. This is used for one method call.
+        :param config: The `BaseLlmConfig` instance to use as configuration options. This is used for one method call.
        To persistently use a config, declare it during app init., defaults to None
        :type config: Optional[BaseLlmConfig], optional
        :param dry_run: A dry run does everything except send the resulting prompt to
@@ -486,7 +506,7 @@ class EmbedChain(JSONSerializable):

        :param input_query: The query to use.
        :type input_query: str
-        :param config: The `LlmConfig` instance to use as configuration options. This is used for one method call.
+        :param config: The `BaseLlmConfig` instance to use as configuration options. This is used for one method call.
        To persistently use a config, declare it during app init., defaults to None
        :type config: Optional[BaseLlmConfig], optional
        :param dry_run: A dry run does everything except send the resulting prompt to
@@ -7,7 +7,7 @@ from embedchain.embedder.base import BaseEmbedder
 from embedchain.models import VectorDimensions


-class VertexAiEmbedder(BaseEmbedder):
+class VertexAIEmbedder(BaseEmbedder):
    def __init__(self, config: Optional[BaseEmbedderConfig] = None):
        super().__init__(config=config)

@@ -0,0 +1,92 @@
+import importlib
+
+
+def load_class(class_type):
+    module_path, class_name = class_type.rsplit(".", 1)
+    module = importlib.import_module(module_path)
+    return getattr(module, class_name)
+
+
+class LlmFactory:
+    provider_to_class = {
+        "anthropic": "embedchain.llm.anthropic.AnthropicLlm",
+        "azure_openai": "embedchain.llm.azure_openai.AzureOpenAILlm",
+        "cohere": "embedchain.llm.cohere.CohereLlm",
+        "gpt4all": "embedchain.llm.gpt4all.GPT4ALLLlm",
+        "huggingface": "embedchain.llm.huggingface.HuggingFaceLlm",
+        "jina": "embedchain.llm.jina.JinaLlm",
+        "llama2": "embedchain.llm.llama2.Llama2Llm",
+        "openai": "embedchain.llm.openai.OpenAILlm",
+        "vertexai": "embedchain.llm.vertex_ai.VertexAILlm",
+    }
+    provider_to_config_class = {
+        "embedchain": "embedchain.config.llm.base.BaseLlmConfig",
+        "openai": "embedchain.config.llm.base.BaseLlmConfig",
+        "anthropic": "embedchain.config.llm.base.BaseLlmConfig",
+    }
+
+    @classmethod
+    def create(cls, provider_name, config_data):
+        class_type = cls.provider_to_class.get(provider_name)
+        # Default to embedchain base config if the provider is not in the config map
+        config_name = "embedchain" if provider_name not in cls.provider_to_config_class else provider_name
+        config_class_type = cls.provider_to_config_class.get(config_name)
+        if class_type:
+            llm_class = load_class(class_type)
+            llm_config_class = load_class(config_class_type)
+            return llm_class(config=llm_config_class(**config_data))
+        else:
+            raise ValueError(f"Unsupported Llm provider: {provider_name}")
+
+
+class EmbedderFactory:
+    provider_to_class = {
+        "gpt4all": "embedchain.embedder.gpt4all.GPT4AllEmbedder",
+        "huggingface": "embedchain.embedder.huggingface.HuggingFaceEmbedder",
+        "vertexai": "embedchain.embedder.vertexai.VertexAIEmbedder",
+        "azure_openai": "embedchain.embedder.openai.OpenAIEmbedder",
+        "openai": "embedchain.embedder.openai.OpenAIEmbedder",
+    }
+    provider_to_config_class = {
+        "openai": "embedchain.config.embedder.base.BaseEmbedderConfig",
+        "azure_openai": "embedchain.config.embedder.base.BaseEmbedderConfig",
+    }
+
+    @classmethod
+    def create(cls, provider_name, config_data):
+        class_type = cls.provider_to_class.get(provider_name)
+        # Default to openai config if the provider is not in the config map
+        config_name = "openai" if provider_name not in cls.provider_to_config_class else provider_name
+        config_class_type = cls.provider_to_config_class.get(config_name)
+        if class_type:
+            embedder_class = load_class(class_type)
+            embedder_config_class = load_class(config_class_type)
+            return embedder_class(config=embedder_config_class(**config_data))
+        else:
+            raise ValueError(f"Unsupported Embedder provider: {provider_name}")
+
+
+class VectorDBFactory:
+    provider_to_class = {
+        "chroma": "embedchain.vectordb.chroma.ChromaDB",
+        "elasticsearch": "embedchain.vectordb.elasticsearch.ElasticsearchDB",
+        "opensearch": "embedchain.vectordb.opensearch.OpenSearchDB",
+        "pinecone": "embedchain.vectordb.pinecone.PineconeDB",
+    }
+    provider_to_config_class = {
+        "chroma": "embedchain.config.vectordb.chroma.ChromaDbConfig",
+        "elasticsearch": "embedchain.config.vectordb.elasticsearch.ElasticsearchDBConfig",
+        "opensearch": "embedchain.config.vectordb.opensearch.OpenSearchDBConfig",
+        "pinecone": "embedchain.config.vectordb.pinecone.PineconeDBConfig",
+    }
+
+    @classmethod
+    def create(cls, provider_name, config_data):
+        class_type = cls.provider_to_class.get(provider_name)
+        config_class_type = cls.provider_to_config_class.get(provider_name)
+        if class_type:
+            embedder_class = load_class(class_type)
+            embedder_config_class = load_class(config_class_type)
+            return embedder_class(config=embedder_config_class(**config_data))
+        else:
+            raise ValueError(f"Unsupported Embedder provider: {provider_name}")
@@ -7,15 +7,15 @@ from embedchain.llm.base import BaseLlm


@register_deserializable
-class AntrophicLlm(BaseLlm):
+class AnthropicLlm(BaseLlm):
    def __init__(self, config: Optional[BaseLlmConfig] = None):
        super().__init__(config=config)

    def get_llm_model_answer(self, prompt):
-        return AntrophicLlm._get_athrophic_answer(prompt=prompt, config=self.config)
+        return AnthropicLlm._get_answer(prompt=prompt, config=self.config)

    @staticmethod
-    def _get_athrophic_answer(prompt: str, config: BaseLlmConfig) -> str:
+    def _get_answer(prompt: str, config: BaseLlmConfig) -> str:
        from langchain.chat_models import ChatAnthropic

        chat = ChatAnthropic(temperature=config.temperature, model=config.model)
@@ -5,9 +5,9 @@ from langchain.memory import ConversationBufferMemory
 from langchain.schema import BaseMessage

 from embedchain.config import BaseLlmConfig
-from embedchain.config.llm.base_llm_config import (
-    DEFAULT_PROMPT, DEFAULT_PROMPT_WITH_HISTORY_TEMPLATE,
-    DOCS_SITE_PROMPT_TEMPLATE)
+from embedchain.config.llm.base import (DEFAULT_PROMPT,
+                                        DEFAULT_PROMPT_WITH_HISTORY_TEMPLATE,
+                                        DOCS_SITE_PROMPT_TEMPLATE)
 from embedchain.helper.json_serializable import JSONSerializable


@@ -174,7 +174,7 @@ class BaseLlm(JSONSerializable):
        :type input_query: str
        :param contexts: Embeddings retrieved from the database to be used as context.
        :type contexts: List[str]
-        :param config: The `LlmConfig` instance to use as configuration options. This is used for one method call.
+        :param config: The `BaseLlmConfig` instance to use as configuration options. This is used for one method call.
        To persistently use a config, declare it during app init., defaults to None
        :type config: Optional[BaseLlmConfig], optional
        :param dry_run: A dry run does everything except send the resulting prompt to
@@ -191,6 +191,9 @@ class BaseLlm(JSONSerializable):
                prev_config = self.config.serialize()
                self.config = config

+            if config is not None and config.query_type == "Images":
+                return contexts
+
            if self.is_docs_site_instance:
                self.config.template = DOCS_SITE_PROMPT_TEMPLATE
                self.config.number_documents = 5
@@ -227,7 +230,7 @@ class BaseLlm(JSONSerializable):
        :type input_query: str
        :param contexts: Embeddings retrieved from the database to be used as context.
        :type contexts: List[str]
-        :param config: The `LlmConfig` instance to use as configuration options. This is used for one method call.
+        :param config: The `BaseLlmConfig` instance to use as configuration options. This is used for one method call.
        To persistently use a config, declare it during app init., defaults to None
        :type config: Optional[BaseLlmConfig], optional
        :param dry_run: A dry run does everything except send the resulting prompt to
@@ -0,0 +1,43 @@
+import importlib
+import os
+from typing import Optional
+
+from langchain.llms import Cohere
+
+from embedchain.config import BaseLlmConfig
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.base import BaseLlm
+
+
+@register_deserializable
+class CohereLlm(BaseLlm):
+    def __init__(self, config: Optional[BaseLlmConfig] = None):
+        if "COHERE_API_KEY" not in os.environ:
+            raise ValueError("Please set the COHERE_API_KEY environment variable.")
+
+        try:
+            importlib.import_module("cohere")
+        except ModuleNotFoundError:
+            raise ModuleNotFoundError(
+                "The required dependencies for Cohere are not installed."
+                'Please install with `pip install --upgrade "embedchain[cohere]"`'
+            ) from None
+
+        super().__init__(config=config)
+
+    def get_llm_model_answer(self, prompt):
+        if self.config.system_prompt:
+            raise ValueError("CohereLlm does not support `system_prompt`")
+        return CohereLlm._get_answer(prompt=prompt, config=self.config)
+
+    @staticmethod
+    def _get_answer(prompt: str, config: BaseLlmConfig) -> str:
+        llm = Cohere(
+            cohere_api_key=os.environ["COHERE_API_KEY"],
+            model=config.model,
+            max_tokens=config.max_tokens,
+            temperature=config.temperature,
+            p=config.top_p,
+        )
+
+        return llm(prompt)
@@ -14,7 +14,7 @@ class GPT4ALLLlm(BaseLlm):
        self.instance = GPT4ALLLlm._get_instance(self.config.model)

    def get_llm_model_answer(self, prompt):
-        return self._get_gpt4all_answer(prompt=prompt, config=self.config)
+        return self._get_answer(prompt=prompt, config=self.config)

    @staticmethod
    def _get_instance(model):
@@ -27,14 +27,14 @@ class GPT4ALLLlm(BaseLlm):

        return GPT4All(model_name=model)

-    def _get_gpt4all_answer(self, prompt: str, config: BaseLlmConfig) -> Union[str, Iterable]:
+    def _get_answer(self, prompt: str, config: BaseLlmConfig) -> Union[str, Iterable]:
        if config.model and config.model != self.config.model:
            raise RuntimeError(
-                "OpenSourceApp does not support switching models at runtime. Please create a new app instance."
+                "GPT4ALLLlm does not support switching models at runtime. Please create a new app instance."
            )

        if config.system_prompt:
-            raise ValueError("OpenSourceApp does not support `system_prompt`")
+            raise ValueError("GPT4ALLLlm does not support `system_prompt`")

        response = self.instance.generate(
            prompt=prompt,
@@ -0,0 +1,51 @@
+import importlib
+import os
+from typing import Optional
+
+from langchain.llms import HuggingFaceHub
+
+from embedchain.config import BaseLlmConfig
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.base import BaseLlm
+
+
+@register_deserializable
+class HuggingFaceLlm(BaseLlm):
+    def __init__(self, config: Optional[BaseLlmConfig] = None):
+        if "HUGGINGFACE_ACCESS_TOKEN" not in os.environ:
+            raise ValueError("Please set the HUGGINGFACE_ACCESS_TOKEN environment variable.")
+
+        try:
+            importlib.import_module("huggingface_hub")
+        except ModuleNotFoundError:
+            raise ModuleNotFoundError(
+                "The required dependencies for HuggingFaceHub are not installed."
+                'Please install with `pip install --upgrade "embedchain[huggingface_hub]"`'
+            ) from None
+
+        super().__init__(config=config)
+
+    def get_llm_model_answer(self, prompt):
+        if self.config.system_prompt:
+            raise ValueError("HuggingFaceLlm does not support `system_prompt`")
+        return HuggingFaceLlm._get_answer(prompt=prompt, config=self.config)
+
+    @staticmethod
+    def _get_answer(prompt: str, config: BaseLlmConfig) -> str:
+        model_kwargs = {
+            "temperature": config.temperature or 0.1,
+            "max_new_tokens": config.max_tokens,
+        }
+
+        if config.top_p > 0.0 and config.top_p < 1.0:
+            model_kwargs["top_p"] = config.top_p
+        else:
+            raise ValueError("`top_p` must be > 0.0 and < 1.0")
+
+        llm = HuggingFaceHub(
+            huggingfacehub_api_token=os.environ["HUGGINGFACE_ACCESS_TOKEN"],
+            repo_id=config.model or "google/flan-t5-xxl",
+            model_kwargs=model_kwargs,
+        )
+
+        return llm(prompt)
@@ -0,0 +1,43 @@
+import os
+from typing import Optional
+
+from langchain.chat_models import JinaChat
+from langchain.schema import HumanMessage, SystemMessage
+
+from embedchain.config import BaseLlmConfig
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.llm.base import BaseLlm
+
+
+@register_deserializable
+class JinaLlm(BaseLlm):
+    def __init__(self, config: Optional[BaseLlmConfig] = None):
+        if "JINACHAT_API_KEY" not in os.environ:
+            raise ValueError("Please set the JINACHAT_API_KEY environment variable.")
+        super().__init__(config=config)
+
+    def get_llm_model_answer(self, prompt):
+        response = JinaLlm._get_answer(prompt, self.config)
+        return response
+
+    @staticmethod
+    def _get_answer(prompt: str, config: BaseLlmConfig) -> str:
+        messages = []
+        if config.system_prompt:
+            messages.append(SystemMessage(content=config.system_prompt))
+        messages.append(HumanMessage(content=prompt))
+        kwargs = {
+            "temperature": config.temperature,
+            "max_tokens": config.max_tokens,
+            "model_kwargs": {},
+        }
+        if config.top_p:
+            kwargs["model_kwargs"]["top_p"] = config.top_p
+        if config.stream:
+            from langchain.callbacks.streaming_stdout import \
+                StreamingStdOutCallbackHandler
+
+            chat = JinaChat(**kwargs, streaming=config.stream, callbacks=[StreamingStdOutCallbackHandler()])
+        else:
+            chat = JinaChat(**kwargs)
+        return chat(messages).content
@@ -27,7 +27,7 @@ class OpenAILlm(BaseLlm):
            messages.append(SystemMessage(content=config.system_prompt))
        messages.append(HumanMessage(content=prompt))
        kwargs = {
-            "model": config.model or "gpt-3.5-turbo-0613",
+            "model": config.model or "gpt-3.5-turbo",
            "temperature": config.temperature,
            "max_tokens": config.max_tokens,
            "model_kwargs": {},
@@ -7,15 +7,15 @@ from embedchain.llm.base import BaseLlm


@register_deserializable
-class VertexAiLlm(BaseLlm):
+class VertexAILlm(BaseLlm):
    def __init__(self, config: Optional[BaseLlmConfig] = None):
        super().__init__(config=config)

    def get_llm_model_answer(self, prompt):
-        return VertexAiLlm._get_athrophic_answer(prompt=prompt, config=self.config)
+        return VertexAILlm._get_answer(prompt=prompt, config=self.config)

    @staticmethod
-    def _get_athrophic_answer(prompt: str, config: BaseLlmConfig) -> str:
+    def _get_answer(prompt: str, config: BaseLlmConfig) -> str:
        from langchain.chat_models import ChatVertexAI

        chat = ChatVertexAI(temperature=config.temperature, model=config.model)
@@ -0,0 +1,41 @@
+import hashlib
+import logging
+import os
+
+from embedchain.loaders.base_loader import BaseLoader
+
+
+class ImagesLoader(BaseLoader):
+    def load_data(self, image_url):
+        """
+        Loads images from the supplied directory/file and applies CLIP model transformation to represent these images
+        in vector form
+
+        :param image_url: The URL from which the images are to be loaded
+        """
+        # load model and image preprocessing
+        from embedchain.models.clip_processor import ClipProcessor
+
+        model = ClipProcessor.load_model()
+        if os.path.isfile(image_url):
+            data = [ClipProcessor.get_image_features(image_url, model)]
+        else:
+            data = []
+            for filename in os.listdir(image_url):
+                filepath = os.path.join(image_url, filename)
+                try:
+                    data.append(ClipProcessor.get_image_features(filepath, model))
+                except Exception as e:
+                    # Log the file that was not loaded
+                    logging.exception("Failed to load the file {}. Exception {}".format(filepath, e))
+        # Get the metadata like Size, Last Modified and Last Created timestamps
+        image_path_metadata = [
+            str(os.path.getsize(image_url)),
+            str(os.path.getmtime(image_url)),
+            str(os.path.getctime(image_url)),
+        ]
+        doc_id = hashlib.sha256((" ".join(image_path_metadata) + image_url).encode()).hexdigest()
+        return {
+            "doc_id": doc_id,
+            "data": data,
+        }
@@ -36,9 +36,8 @@ class SitemapLoader(BaseLoader):
        for link in links:
            try:
                each_load_data = web_page_loader.load_data(link)
-
-                if is_readable(each_load_data[0].get("content")):
-                    output.append(each_load_data)
+                if is_readable(each_load_data.get("data")[0].get("content")):
+                    output.append(each_load_data.get("data"))
                else:
                    logging.warning(f"Page is not readable (too many invalid characters): {link}")
            except ParserRejectedMarkup as e:
@@ -15,7 +15,25 @@ class WebPageLoader(BaseLoader):
        """Load data from a web page."""
        response = requests.get(url)
        data = response.content
-        soup = BeautifulSoup(data, "html.parser")
+        content = self._get_clean_content(data, url)
+
+        meta_data = {
+            "url": url,
+        }
+
+        doc_id = hashlib.sha256((content + url).encode()).hexdigest()
+        return {
+            "doc_id": doc_id,
+            "data": [
+                {
+                    "content": content,
+                    "meta_data": meta_data,
+                }
+            ],
+        }
+
+    def _get_clean_content(self, html, url) -> str:
+        soup = BeautifulSoup(html, "html.parser")
        original_size = len(str(soup.get_text()))

        tags_to_exclude = [
@@ -61,17 +79,4 @@ class WebPageLoader(BaseLoader):
                f"[{url}] Cleaned page size: {cleaned_size} characters, down from {original_size} (shrunk: {original_size-cleaned_size} chars, {round((1-(cleaned_size/original_size)) * 100, 2)}%)"  # noqa:E501
            )

-        meta_data = {
-            "url": url,
-        }
-        content = content
-        doc_id = hashlib.sha256((content + url).encode()).hexdigest()
-        return {
-            "doc_id": doc_id,
-            "data": [
-                {
-                    "content": content,
-                    "meta_data": meta_data,
-                }
-            ],
-        }
+        return content
@@ -0,0 +1,26 @@
+import hashlib
+
+from langchain.document_loaders import UnstructuredXMLLoader
+
+from embedchain.helper.json_serializable import register_deserializable
+from embedchain.loaders.base_loader import BaseLoader
+from embedchain.utils import clean_string
+
+
+@register_deserializable
+class XmlLoader(BaseLoader):
+    def load_data(self, xml_url):
+        """Load data from a XML file."""
+        loader = UnstructuredXMLLoader(xml_url)
+        data = loader.load()
+        content = data[0].page_content
+        content = clean_string(content)
+        meta_data = data[0].metadata
+        meta_data["url"] = meta_data["source"]
+        del meta_data["source"]
+        output = [{"content": content, "meta_data": meta_data}]
+        doc_id = hashlib.sha256((content + xml_url).encode()).hexdigest()
+        return {
+            "doc_id": doc_id,
+            "data": output,
+        }
@@ -0,0 +1,42 @@
+try:
+    from PIL import Image, UnidentifiedImageError
+    from sentence_transformers import SentenceTransformer
+except ImportError:
+    raise ImportError("Images requires extra dependencies. Install with `pip install 'embedchain[images]'") from None
+
+MODEL_NAME = "clip-ViT-B-32"
+
+
+class ClipProcessor:
+    @staticmethod
+    def load_model():
+        """Load data from a director of images."""
+        # load model and image preprocessing
+        model = SentenceTransformer(MODEL_NAME)
+        return model
+
+    @staticmethod
+    def get_image_features(image_url, model):
+        """
+        Applies the CLIP model to evaluate the vector representation of the supplied image
+        """
+        try:
+            # load image
+            image = Image.open(image_url)
+        except FileNotFoundError:
+            raise FileNotFoundError("The supplied file does not exist`")
+        except UnidentifiedImageError:
+            raise UnidentifiedImageError("The supplied file is not an image`")
+
+        image_features = model.encode(image)
+        meta_data = {"url": image_url}
+        return {"content": image_url, "embedding": image_features.tolist(), "meta_data": meta_data}
+
+    @staticmethod
+    def get_text_features(query):
+        """
+        Applies the CLIP model to evaluate the vector representation of the supplied text
+        """
+        model = ClipProcessor.load_model()
+        text_features = model.encode(query)
+        return text_features.tolist()
@@ -18,11 +18,13 @@ class IndirectDataType(Enum):
    PDF_FILE = "pdf_file"
    WEB_PAGE = "web_page"
    SITEMAP = "sitemap"
+    XML = "xml"
    DOCX = "docx"
    DOCS_SITE = "docs_site"
    NOTION = "notion"
    CSV = "csv"
    MDX = "mdx"
+    IMAGES = "images"


 class SpecialDataType(Enum):
@@ -39,9 +41,11 @@ class DataType(Enum):
    PDF_FILE = IndirectDataType.PDF_FILE.value
    WEB_PAGE = IndirectDataType.WEB_PAGE.value
    SITEMAP = IndirectDataType.SITEMAP.value
+    XML = IndirectDataType.XML.value
    DOCX = IndirectDataType.DOCX.value
    DOCS_SITE = IndirectDataType.DOCS_SITE.value
    NOTION = IndirectDataType.NOTION.value
    CSV = IndirectDataType.CSV.value
    MDX = IndirectDataType.MDX.value
    QNA_PAIR = SpecialDataType.QNA_PAIR.value
+    IMAGES = IndirectDataType.IMAGES.value
@@ -5,3 +5,4 @@ class VectorDatabases(Enum):
    CHROMADB = "CHROMADB"
    ELASTICSEARCH = "ELASTICSEARCH"
    OPENSEARCH = "OPENSEARCH"
+    ZILLIZ = "ZILLIZ"
@@ -190,6 +190,10 @@ def detect_datatype(source: Any) -> DataType:
            logging.debug(f"Source of `{formatted_source}` detected as `csv`.")
            return DataType.CSV

+        if source.endswith(".xml"):
+            logging.debug(f"Source of `{formatted_source}` detected as `xml`.")
+            return DataType.XML
+
        # If the source is a valid file, that's not detectable as a type, an error is raised.
        # It does not fallback to text.
        raise ValueError(
@@ -37,7 +37,7 @@ class ChromaDB(BaseVectorDB):
            self.config = ChromaDbConfig()

        self.settings = Settings()
-        self.settings.allow_reset = self.config.allow_reset
+        self.settings.allow_reset = self.config.allow_reset if hasattr(self.config, "allow_reset") else False
        if self.config.chroma_settings:
            for key, value in self.config.chroma_settings.items():
                if hasattr(self.settings, key):
@@ -72,6 +72,17 @@ class ChromaDB(BaseVectorDB):
        """Called during initialization"""
        return self.client

+    def _generate_where_clause(self, where: Dict[str, any]) -> str:
+        # If only one filter is supplied, return it as is
+        # (no need to wrap in $and based on chroma docs)
+        if len(where.keys()) == 1:
+            return where
+        where_filters = []
+        for k, v in where.items():
+            if isinstance(v, str):
+                where_filters.append({k: v})
+        return {"$and": where_filters}
+
    def _get_or_create_collection(self, name: str) -> Collection:
        """
        Get or create a named collection.
@@ -107,26 +118,41 @@ class ChromaDB(BaseVectorDB):
        if ids:
            args["ids"] = ids
        if where:
-            args["where"] = where
+            args["where"] = self._generate_where_clause(where)
        if limit:
            args["limit"] = limit
        return self.collection.get(**args)

    def get_advanced(self, where):
-        return self.collection.get(where=where, limit=1)
+        where_clause = self._generate_where_clause(where)
+        return self.collection.get(where=where_clause, limit=1)

-    def add(self, documents: List[str], metadatas: List[object], ids: List[str]) -> Any:
+    def add(
+        self,
+        embeddings: List[List[float]],
+        documents: List[str],
+        metadatas: List[object],
+        ids: List[str],
+        skip_embedding: bool,
+    ) -> Any:
        """
        Add vectors to chroma database

+        :param embeddings: list of embeddings to add
+        :type embeddings: List[List[str]]
        :param documents: Documents
        :type documents: List[str]
        :param metadatas: Metadatas
        :type metadatas: List[object]
        :param ids: ids
        :type ids: List[str]
+        :param skip_embedding: Optional. If True, then the embeddings are assumed to be already generated.
+        :type skip_embedding: bool
        """
-        self.collection.add(documents=documents, metadatas=metadatas, ids=ids)
+        if skip_embedding:
+            self.collection.add(embeddings=embeddings, documents=documents, metadatas=metadatas, ids=ids)
+        else:
+            self.collection.add(documents=documents, metadatas=metadatas, ids=ids)

    def _format_result(self, results: QueryResult) -> list[tuple[Document, float]]:
        """
@@ -146,9 +172,9 @@ class ChromaDB(BaseVectorDB):
            )
        ]

-    def query(self, input_query: List[str], n_results: int, where: Dict[str, Any]) -> List[str]:
+    def query(self, input_query: List[str], n_results: int, where: Dict[str, any], skip_embedding: bool) -> List[str]:
        """
-        Query contents from vector data base based on vector similarity
+        Query contents from vector database based on vector similarity

        :param input_query: list of query string
        :type input_query: List[str]
@@ -156,24 +182,34 @@ class ChromaDB(BaseVectorDB):
        :type n_results: int
        :param where: to filter data
        :type where: Dict[str, Any]
+        :param skip_embedding: Optional. If True, then the input_query is assumed to be already embedded.
+        :type skip_embedding: bool
        :raises InvalidDimensionException: Dimensions do not match.
        :return: The content of the document that matched your query.
        :rtype: List[str]
        """
        try:
-            result = self.collection.query(
-                query_texts=[
-                    input_query,
-                ],
-                n_results=n_results,
-                where=where,
-            )
+            if skip_embedding:
+                result = self.collection.query(
+                    query_embeddings=[
+                        input_query,
+                    ],
+                    n_results=n_results,
+                    where=where,
+                )
+            else:
+                result = self.collection.query(
+                    query_texts=[
+                        input_query,
+                    ],
+                    n_results=n_results,
+                    where=where,
+                )
        except InvalidDimensionException as e:
            raise InvalidDimensionException(
                e.message()
                + ". This is commonly a side-effect when an embedding function, different from the one used to add the embeddings, is used to retrieve an embedding from the database."  # noqa E501
            ) from None
-
        results_formatted = self._format_result(result)
        contents = [result[0].page_content for result in results_formatted]
        return contents
@@ -1,5 +1,5 @@
 import logging
-from typing import Dict, List, Optional, Set
+from typing import Any, Dict, List, Optional

 try:
    from elasticsearch import Elasticsearch
@@ -74,9 +74,7 @@ class ElasticsearchDB(BaseVectorDB):
    def _get_or_create_collection(self, name):
        """Note: nothing to return here. Discuss later"""

-    def get(
-        self, ids: Optional[List[str]] = None, where: Optional[Dict[str, any]] = None, limit: Optional[int] = None
-    ) -> Set[str]:
+    def get(self, ids: Optional[List[str]] = None, where: Optional[Dict[str, any]] = None, limit: Optional[int] = None):
        """
        Get existing doc ids present in vector database

@@ -100,19 +98,32 @@ class ElasticsearchDB(BaseVectorDB):
        ids = [doc["_id"] for doc in docs]
        return {"ids": set(ids)}

-    def add(self, documents: List[str], metadatas: List[object], ids: List[str]):
-        """add data in vector database
-
+    def add(
+        self,
+        embeddings: List[List[float]],
+        documents: List[str],
+        metadatas: List[object],
+        ids: List[str],
+        skip_embedding: bool,
+    ) -> Any:
+        """
+        add data in vector database
+        :param embeddings: list of embeddings to add
+        :type embeddings: List[List[str]]
        :param documents: list of texts to add
        :type documents: List[str]
        :param metadatas: list of metadata associated with docs
        :type metadatas: List[object]
        :param ids: ids of docs
        :type ids: List[str]
+        :param skip_embedding: Optional. If True, then the input_query is assumed to be already embedded.
+        :type skip_embedding: bool
        """

        docs = []
-        embeddings = self.embedder.embedding_fn(documents)
+        if not skip_embedding:
+            embeddings = self.embedder.embedding_fn(documents)
+
        for id, text, metadata, embeddings in zip(ids, documents, metadatas, embeddings):
            docs.append(
                {
@@ -124,7 +135,7 @@ class ElasticsearchDB(BaseVectorDB):
        bulk(self.client, docs)
        self.client.indices.refresh(index=self._get_index())

-    def query(self, input_query: List[str], n_results: int, where: Dict[str, any]) -> List[str]:
+    def query(self, input_query: List[str], n_results: int, where: Dict[str, any], skip_embedding: bool) -> List[str]:
        """
        query contents from vector data base based on vector similarity

@@ -134,11 +145,17 @@ class ElasticsearchDB(BaseVectorDB):
        :type n_results: int
        :param where: Optional. to filter data
        :type where: Dict[str, any]
+        :param skip_embedding: Optional. If True, then the input_query is assumed to be already embedded.
+        :type skip_embedding: bool
        :return: Database contents that are the result of the query
        :rtype: List[str]
        """
-        input_query_vector = self.embedder.embedding_fn(input_query)
-        query_vector = input_query_vector[0]
+        if skip_embedding:
+            query_vector = input_query
+        else:
+            input_query_vector = self.embedder.embedding_fn(input_query)
+            query_vector = input_query_vector[0]
+
        query = {
            "script_score": {
                "query": {"bool": {"must": [{"exists": {"field": "text"}}]}},
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
Deshraj Yadav	c336292346	Update version to v0.0.72 (#809 )	2023-10-16 13:33:36 -07:00
Deshraj Yadav	adf50f1e81	[Docs] Add docs for Azure OpenAI provider (#804 )	2023-10-16 13:31:56 -07:00
Deshraj Yadav	636bc0a99d	[feature]: Improve pinecone db integration (#806 )	2023-10-15 02:26:35 -07:00
Rupesh Bansal	a7a61fae1d	[Feature] Pinecone Vector DB support (#723 )	2023-10-15 01:54:07 -07:00
Sidharth Mohanty	5ec12212e4	Improve tests (#800 )	2023-10-14 19:16:27 -07:00
Deshraj Yadav	77c90a308e	[Docs]: Clean up docs (#802 )	2023-10-14 19:14:24 -07:00
Deshraj Yadav	4a8c50f886	[docs]: Revamp embedchain docs (#799 )	2023-10-13 15:38:15 -07:00
Deshraj Yadav	a86d7f52e9	[Feature]: Add support for creating app using yaml config (#787 )	2023-10-12 15:35:49 -07:00
Sidharth Mohanty	4820ea15d6	Improve tests (#795 )	2023-10-12 13:15:22 -07:00
Deshraj Yadav	b5de605e2b	Update version to 0.0.69 (#792 )	2023-10-11 13:20:59 -07:00
LuciAkirami	d6ed2050d4	feature: Add support for zilliz vector database (#771 )	2023-10-11 13:17:33 -07:00
Deshraj Yadav	16e123b7bb	[docs]: add telemetry information in readme (#786 )	2023-10-09 13:02:55 -07:00
Deshraj Yadav	4eb91683a9	Bump version to 0.0.68 (#785 )	2023-10-09 12:41:30 -07:00
Sidharth Mohanty	0cb78b9067	Add Hugging Face Hub LLM support (#762 )	2023-10-09 12:15:22 -07:00
Sidharth Mohanty	e226a89637	Add Jina LLM support (#760 )	2023-10-09 12:06:36 -07:00
SerSamgy	431f8c2c6a	Feat: Improve test coverage of DocsSiteLoader (#758 )	2023-10-09 12:03:40 -07:00
Rupesh Bansal	19a9141c2d	Added Clip dependency (#778 )	2023-10-09 12:02:45 -07:00
Rupesh Bansal	bc649b9a85	Added docs for skip_embedding and embeddings argument of vectordbs (#784 )	2023-10-09 12:01:44 -07:00
Shreya Shrivastava	702067e521	Improve user readability of .env.example (#781 )	2023-10-09 12:01:23 -07:00
Sidharth Mohanty	03a84daf9d	Add Cohere LLM support (#751 )	2023-10-09 11:54:24 -07:00
Sidharth Mohanty	b91d922600	Improve tests (#780 )	2023-10-09 11:26:21 -07:00
Prikshit	ed02aebf9a	Rename 'PersonApp.py' to 'person_app.py' (#752 )	2023-10-09 08:05:11 -07:00
Prikshit	1a048390fd	Rename _get_athrophic_answer to _get_answer (#775 )	2023-10-07 02:22:49 -07:00
Richard Awoyemi	1741d3bef6	[fix]: Fix sitemap loader (#753 )	2023-10-06 16:24:15 -07:00
Ojuswi Rastogi	540a0a3685	[feat]: Add support for XML file format (#757 )	2023-10-06 15:39:32 -07:00
SerSamgy	d2fd3ce434	[tests]: add more tests for pdf_file loader (#769 )	2023-10-06 14:10:45 -07:00
Deshraj Yadav	ea76868d65	[docs]: update readme (#767 )	2023-10-04 18:14:16 -07:00
Deshraj Yadav	f31351bedb	[OpenSearch] Small bug fixes in query	2023-10-04 18:07:46 -07:00
Deshraj Yadav	8863983c7b	[Images] Remove 'clip' from the list of depdencies since pypi doesn't allow it (#766 )	2023-10-04 17:08:27 -07:00
Deshraj Yadav	64a34cac32	[OpenSearch] Add chunks specific to an app_id if present (#765 )	2023-10-04 15:46:22 -07:00
Deshraj Yadav	352e71461d	[OpenSearch]: Fix `add()` and `query()` for opensearch db (#764 )	2023-10-04 12:53:07 -07:00
Deshraj Yadav	87d0b5c76f	[bugfix] Fix issue when llm config is not defined (#763 )	2023-10-04 12:08:21 -07:00
Rupesh Bansal	d0af018b8d	Add support for image dataset (#571 ) Co-authored-by: Rupesh Bansal <rupeshbansal@Shankars-MacBook-Air.local>	2023-10-04 09:50:40 +05:30
Taranjeet Singh	55e9a1cbd6	fix: update notebook link and link in example (#748 )	2023-10-01 04:43:26 +05:30
Taranjeet Singh	65bafb75b1	feat: bump version to 0.0.65 (#747 )	2023-10-01 04:28:26 +05:30
Taranjeet Singh	01fd1c2437	docs: add codecov.io badge in readme (#746 )	2023-10-01 04:24:49 +05:30
Taranjeet Singh	78ba4468b0	docs: add release note & fix emoji in contribution (#745 )	2023-10-01 04:21:44 +05:30
Taranjeet Singh	8581c7ecce	docs: add contribution section (#744 )	2023-10-01 04:16:09 +05:30
Taranjeet Singh	9be6fe6bc3	docs: add community section with links and showcase (#743 )	2023-10-01 04:06:23 +05:30
Taranjeet Singh	8c506da21e	docs: add google form link (#742 )	2023-10-01 03:54:35 +05:30
Taranjeet Singh	c02002eb4b	fix: typo in gpt-4 model (#741 )	2023-10-01 00:49:27 +05:30
Rajat Gupta	57ecfca862	Setup codecov.io to measure test coverage #696 (#739 )	2023-09-30 23:56:49 +05:30
Taranjeet Singh	28d41e9397	fix: improve add data section (#740 )	2023-09-30 23:43:44 +05:30
Prikshit	7a1866d280	Update outdated 'OpenAI' Model (#735 )	2023-09-30 23:42:33 +05:30
Rhythm Sharma	d229b108c3	fix: Rename _get_athrophic_answer to _get_answer in anthropic llm class (#732 )	2023-09-30 12:17:48 +05:30
Taranjeet Singh	39640cb697	feat: bump version to 0.0.64 (#733 )	2023-09-30 12:16:22 +05:30
cachho	9ecf2e9feb	feat: One App (#635 ) Co-authored-by: Taranjeet Singh <reachtotj@gmail.com>	2023-09-30 12:00:43 +05:30
Taranjeet Singh	2db07cdb1f	docs: add gpt-4 as llm FAQ (#731 )	2023-09-30 10:24:49 +05:30
Taranjeet Singh	faa29ef285	fix: Update doc heading name (#730 )	2023-09-30 10:01:57 +05:30
Prikshit	16b0d5b829	Rename method _get_gpt4all_answer to _get_answer (#727 )	2023-09-30 09:45:31 +05:30
Deshraj Yadav	6ae33d04b8	[OpenSearch] Add support for filtering docs based on app_id in opensearch db (#729 )	2023-09-29 15:19:10 -07:00