[docs]: Revamp embedchain docs (#799 )

[Feature]: Add support for creating app using yaml config (#787 )
Improve tests (#795 )
2023-10-13 15:38:15 -07:00 · 2023-10-12 15:35:49 -07:00 · 2023-10-12 13:15:22 -07:00 · 2023-10-11 13:20:59 -07:00 · 2023-10-11 13:17:33 -07:00 · 2023-10-09 13:02:55 -07:00
241 changed files with 26132 additions and 1368 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 }}
+
@@ -4,27 +4,41 @@ 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:
-	$(PIP) install --upgrade pip
-	$(PIP) install -e .[dev]
+	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
+
+py_shell:
+	poetry run python

 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
@@ -1,12 +1,18 @@
 # embedchain

 [![PyPI](https://img.shields.io/pypi/v/embedchain)](https://pypi.org/project/embedchain/)
+[![Slack](https://img.shields.io/badge/slack-embedchain-brightgreen.svg?logo=slack)](https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw)
 [![Discord](https://dcbadge.vercel.app/api/server/6PzXDgEjG5?style=flat)](https://discord.gg/CUU9FPhRNt)
 [![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 framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchain/tree/main/embedchain-js)
+
+## Community
+
+* Join embedchain community on slack by accepting [this invite](https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw)

 ## 🤝 Schedule a 1-on-1 Session

@@ -22,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

@@ -30,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

@@ -40,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

@@ -56,12 +64,12 @@ elon_bot = App()

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

 # Query the bot
-elon_bot.query("How many companies does Elon Musk run?")
-# Answer: Elon Musk runs four companies: Tesla, SpaceX, Neuralink, and The Boring Company
+elon_bot.query("How many companies does Elon Musk run and name those?")
+# 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.
 ```

 ## 🤝 Contributing
@@ -75,13 +83,17 @@ 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},
+  author = {Taranjeet Singh, Deshraj Yadav},
  title = {Embedchain: Framework to easily create LLM powered bots over any dataset},
  year = {2023},
  publisher = {GitHub},
@@ -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,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: 'full-stack-app'
+    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 @@
+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 embedchain[opensource]`.
-
-### CustomApp
-
-```python
-from embedchain import CustomApp
-from embedchain.config import (CustomAppConfig, ElasticsearchDBConfig,
-                               EmbedderConfig, LlmConfig)
-from embedchain.embedder.vertexai_embedder import VertexAiEmbedder
-from embedchain.llm.vertex_ai_llm import VertexAiLlm
-from embedchain.models import EmbeddingFunctions, Providers
-from embedchain.vectordb.elasticsearch_db 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,150 +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")
-```
-
-### 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 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")
-```
-
-## 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 `query` and `chat` methods that allows the user to not send their constructed prompt 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 `QueryConfig` 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 = QueryConfig(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.count())
-# returns: 481
-```
@@ -49,11 +49,7 @@ Default values of chunker config parameters for different `data_type`:
 |docs_site|500|50|len|
 |notion|300|0|len|

-### LoaderConfig
-
-_coming soon_
-
-## LlmConfig
+## BaseLlmConfig

 |option|description|type|default|
 |---|---|---|---|
@@ -67,11 +63,4 @@ _coming soon_
 |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|
-
-## 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.
+|where|filter for context search.|dict|None|
@@ -6,11 +6,9 @@ title: '🧪 Testing'

 ### Dry Run

-Before you consume valueable tokens, you should make sure that the embedding you have done works and that it's receiving the correct document from the database.
+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 this you can use the `dry_run` option in your `query` or `chat` method.
-
-Following the example above, add this to your script:
+- 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))
@@ -26,4 +24,17 @@ A: Naval Ravikant is an Indian-American entrepreneur and investor.

 _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.**
+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
+'''
+```
@@ -2,33 +2,117 @@
 title: '💾 Vector Database'
 ---

-We support `Chroma` and `Elasticsearch` as two vector database. 
+We support `Chroma`, `Elasticsearch` and `OpenSearch` as vector databases.
 `Chroma` is used as a default database.

-### Elasticsearch
-In order to use `Elasticsearch` as vector database we need to use App type `CustomApp`. 
+## 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.models import Providers, EmbeddingFunctions, VectorDatabases
-
-os.environ["OPENAI_API_KEY"] = 'OPENAI_API_KEY'
+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='http://localhost:9200',
-	# pass named parameters supported by Python Elasticsearch client
-	ca_certs="/path/to/http_ca.crt",
-	basic_auth=("username", "password")
+    # 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),
 )
-config = CustomAppConfig(
-	embedding_fn=EmbeddingFunctions.OPENAI, 
-	provider=Providers.OPENAI, 
-	db_type=VectorDatabases.ELASTICSEARCH, 
-	es_config=es_config,
-)
-es_app = CustomApp(config)
 ```
- Set `db_type=VectorDatabases.ELASTICSEARCH` and `es_config=ElasticsearchDBConfig(es_url='')` in `CustomAppConfig`.
- `ElasticsearchDBConfig` accepts `es_url` as elasticsearch url or as list of nodes url with different hosts and ports. Additionally we can pass named parameters supported by Python Elasticsearch client.
+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,18 @@
+---
+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:
+
+
+* Slack: Our Slack workspace provides a platform for more structured discussions and channels dedicated to different topics. Feel free to jump in and start contributing. [Join Slack](https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw).
+
+* Discord: Join our Discord server to engage in real-time conversations with the community members and the project maintainers. It’s a great place to seek help and discuss anything related to the project. [Join Discord](https://discord.gg/CUU9FPhRNt).
+
+* Twitter: Follow us on Twitter for the latest news, announcements, and highlights from our community. It’s also a quick way to reach out to us. [Follow @embedchain](https://twitter.com/embedchain).
+
+* LinkedIn: Connect with us on LinkedIn to stay updated on official announcements, job openings, and professional networking opportunities within our community. [Follow Our Page](https://www.linkedin.com/company/embedchain/).
+
+* Newsletter: Subscribe to our newsletter for a curated list of project updates, community contributions, and upcoming events. It’s a compact way to stay in the loop with what’s happening in our community. [Subscribe Now](https://embedchain.substack.com/).
+
+We look forward to connecting with you and seeing how we can create amazing things together!
@@ -0,0 +1,135 @@
+---
+title: 🧩 Embedding models
+---
+
+## Overview
+
+Embedchain supports several embedding models from the following providers:
+
+<CardGroup cols={4}>
+  <Card title="OpenAI" href="#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 openai.yaml file
+app = App.from_config(yaml_path="openai.yaml")
+
+app.add("https://en.wikipedia.org/wiki/OpenAI")
+app.query("What is OpenAI?")
+```
+
+```yaml openai.yaml
+embedder:
+  provider: openai
+  config:
+    model: 'text-embedding-ada-002'
+```
+
+</CodeGroup>
+
+## 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 gpt4all.yaml file
+app = App.from_config(yaml_path="gpt4all.yaml")
+```
+
+```yaml gpt4all.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 huggingface.yaml file
+app = App.from_config(yaml_path="huggingface.yaml")
+```
+
+```yaml huggingface.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 vertexai.yaml file
+app = App.from_config(yaml_path="vertexai.yaml")
+```
+
+```yaml vertexai.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,280 @@
+---
+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/embedchain/yaml/chroma.yaml) file. 
+
+<CodeGroup>
+
+```python main.py
+import os
+from embedchain import App
+
+os.environ['OPENAI_API_KEY'] = 'xxx'
+
+# load llm configuration from openai.yaml file
+app = App.from_config(yaml_path="openai.yaml")
+```
+
+```yaml openai.yaml
+llm:
+  provider: openai
+  model: 'gpt-3.5-turbo'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+
+</CodeGroup>
+
+
+## Azure OpenAI
+
+_Coming soon_
+
+## 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 anthropic.yaml file
+app = App.from_config(yaml_path="anthropic.yaml")
+```
+
+```yaml anthropic.yaml
+llm:
+  provider: anthropic
+  model: 'claude-instant-1'
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+
+</CodeGroup>
+
+<br />
+
+<Tip>
+You may also have to set the `OPENAI_API_KEY` if you use the OpenAI's embedding model.
+</Tip>
+
+
+## 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 cohere.yaml file
+app = App.from_config(yaml_path="cohere.yaml")
+```
+
+```yaml cohere.yaml
+llm:
+  provider: cohere
+  model: large
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+```
+
+</CodeGroup>
+
+## GPT4ALL
+
+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 gpt4all.yaml file
+app = App.from_config(yaml_path="gpt4all.yaml")
+```
+
+```yaml gpt4all.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 jina.yaml file
+app = App.from_config(yaml_path="jina.yaml")
+```
+
+```yaml jina.yaml
+llm:
+  provider: jina
+  config:
+    temperature: 0.5
+    max_tokens: 1000
+    top_p: 1
+    stream: false
+```
+</CodeGroup>
+
+
+## Hugging Face
+
+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 huggingface.yaml file
+app = App.from_config(yaml_path="huggingface.yaml")
+```
+
+```yaml huggingface.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 llama2.yaml file
+app = App.from_config(yaml_path="llama2.yaml")
+```
+
+```yaml llama2.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 vertexai.yaml file
+app = App.from_config(yaml_path="vertexai.yaml")
+```
+
+```yaml vertexai.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,142 @@
+---
+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="chroma-config-1.yaml")
+```
+
+```yaml chroma-config-1.yaml
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-collection'
+    dir: db
+    allow_reset: true
+```
+
+```yaml chroma-config-2.yaml
+vectordb:
+  provider: chroma
+  config:
+    collection_name: 'my-collection'
+    host: localhost
+    port: 5200
+    allow_reset: true
+```
+
+</CodeGroup>
+
+
+## Elasticsearch
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load elasticsearch configuration from yaml file
+app = App.from_config(yaml_path="elasticsearch.yaml")
+```
+
+```yaml elasticsearch.yaml
+vectordb:
+  provider: elasticsearch
+  config:
+    collection_name: 'es-index'
+    es_url: http://localhost:9200
+    allow_reset: true
+    api_key: xxx
+```
+</CodeGroup>
+
+## OpenSearch
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load opensearch configuration from yaml file
+app = App.from_config(yaml_path="opensearch.yaml")
+```
+
+```yaml opensearch.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
+
+<CodeGroup>
+
+```python main.py
+from embedchain import App
+
+# load zilliz configuration from yaml file
+app = App.from_config(yaml_path="zilliz.yaml")
+```
+
+```yaml zilliz.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
+
+_Coming soon_
+
+## Qdrant
+
+_Coming soon_
+
+## Weaviate
+
+_Coming soon_
+
+<Snippet file="missing-vector-db-tip.mdx" />
@@ -42,7 +42,6 @@ embedchain is built on the following stack:
 ### Maintainer

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

 ### Citation

@@ -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')
+```
@@ -26,7 +26,7 @@ Send Messages (under Text Permissions)
 1. Install embedchain python package:

 ```bash
-pip install "embedchain[discord]"
+pip install --upgrade "embedchain[discord]"
 ```

 2. Launch your Discord bot:
@@ -53,6 +53,10 @@ python -m embedchain.bots.discord --include-question
 ```text
 /query <question>
 ```
+- You can chat with the bot using the slash command:
+```text
+/chat <question>
+```
 📝 Note: To use the bot privately, you can message the bot directly by right clicking the bot and selecting `Message`.

 🎉 Happy Chatting! 🎉
@@ -7,7 +7,7 @@ title: '🔮 Poe Bot'
 1. Install embedchain python package:

 ```bash
-pip install "embedchain[poe]"
+pip install --upgrade "embedchain[poe]"
 ```

 2. Create a free account on [Poe](https://www.poe.com?utm_source=embedchain).
@@ -7,7 +7,7 @@ title: '💬 WhatsApp Bot'
 1. Install embedchain python package:

 ```bash
-pip install embedchain
+pip install --upgrade embedchain
 ```

 2. Launch your WhatsApp bot:
@@ -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" />
@@ -1,47 +1,51 @@
 ---
 title: 📚 Introduction
-description: '📝 Embedchain is a framework to easily create LLM powered bots over any dataset.'
+description: '📝 Embedchain is a framework to easily create LLM powered apps on your data.'
 ---

 ## 🤔 What is Embedchain?

-Embedchain abstracts the entire process of loading a dataset, chunking it, creating embeddings, and storing it in a vector database.
+Embedchain abstracts the entire process of loading data, 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.
+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_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_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'})

-# Embed Local Resources
-naval_chat_bot.add(("Who is Naval Ravikant?", "Naval Ravikant is an Indian-American entrepreneur and investor."))
+# Add local resources
+naval_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?")
+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.
+
+# Ask questions with specific context
+naval_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:
+Embedchain abstracts out the following steps from you to easily create LLM powered apps:

-1. Detect the data type and load the data
+1. Detect the data type and load data
 2. Create meaningful chunks
 3. Create embeddings for each chunk
-4. Store the chunks in a vector database
+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.
+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:

@@ -51,6 +55,4 @@ The process of loading the dataset and querying involves multiple steps, each wi
 - 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.
+Embedchain takes care of all these nuances and provides a simple interface to create apps on any data.
@@ -0,0 +1,52 @@
+---
+title: '🚀 Quickstart'
+description: '💡 Start building LLM powered apps under 30 seconds'
+---
+
+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
+# Embed online resources
+elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
+elon_bot.add("https://www.forbes.com/profile/elon-musk")
+```
+  </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()
+
+# Embed online resources
+elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
+elon_bot.add("https://www.forbes.com/profile/elon-musk")
+
+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.
+```
@@ -0,0 +1,51 @@
+---
+title: '🛠️ LangSmith'
+description: 'Integrate with Langsmith to debug and monitor your LLM app'
+---
+
+Embedchain now supports integration with [LangSmith](https://www.langchain.com/langsmith).
+
+To use langsmith, you need to do the following steps
+
+1. Have an account on langsmith and keep the environment variables in handy
+2. Set the environments variables in your app so that embedchain has context about it.
+3. Just use embedchain and everything will be logged to LangSmith, so that you can better test and monitor your application.
+
+Lets cover each step in detail.
+
+* First make sure that you a LangSmith account created and have all the necessary variables handy. LangSmith has a [good documentation](https://docs.smith.langchain.com/) on how to get started with their service.
+
+* Once you have the account setup, we will need the following environment variables
+
+```bash
+export LANGCHAIN_TRACING_V2=true
+export LANGCHAIN_ENDPOINT=https://api.smith.langchain.com
+export LANGCHAIN_API_KEY=<your-api-key>
+export LANGCHAIN_PROJECT=<your-project>  # if not specified, defaults to "default"
+```
+
+If you are using Python, you can use the following code to set environment variables
+
+```python
+import os
+
+os.environ['LANGCHAIN_TRACING_V2'] = 'true'
+os.environ['LANGCHAIN_ENDPOINT'] = 'https://api.smith.langchain.com'
+os.environ['LANGCHAIN_API_KEY'] = <your-api-key>
+os.environ['LANGCHAIN_PROJECT] = <your-project>
+```
+
+* Now create an app using embedchain and everything will be automatically visible in the LangSmith
+
+
+```python
+from embedchain import App
+
+app = App()
+app.add("https://en.wikipedia.org/wiki/Elon_Musk")
+app.query("How many companies did Elon found?")
+```
+
+* Now the entire log for this will be visible in langsmith.
+
+<img src="/images/langsmith.png"/>
@@ -16,6 +16,10 @@
      "name": "Twitter",
      "url": "https://twitter.com/embedchain"
    },
+    {
+      "name":"Slack",
+      "url":"https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw"
+    },
    {
      "name": "Discord",
      "url": "https://discord.gg/6PzXDgEjG5"
@@ -27,29 +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": "Contribution Guidelines",
-      "pages": ["contribution/dev", "contribution/docs"]
+      "group": "Community",
+      "pages": [
+        "community/connect-with-us",
+        "community/showcase"
+      ]
+    },
+    {
+      "group": "Integrations",
+      "pages": ["integration/langsmith"]
+    },
+    {
+      "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",
+    "website": "https://embedchain.ai",
    "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",
+    "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 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.tesla.com/elon-musk")
-
-response = elon_musk_bot.query("How many companies does Elon Musk run?")
-print(response)
-# Answer: 'Elon Musk runs four companies: Tesla, SpaceX, Neuralink, and The Boring Company.'
-```
@@ -0,0 +1,2 @@
+node_modules
+dist
@@ -0,0 +1,56 @@
+{
+    // Configuration for JavaScript files
+    "extends": [
+      "airbnb-base",
+      "plugin:prettier/recommended"
+    ],
+    "rules": {
+      "prettier/prettier": [
+        "error",
+        {
+          "singleQuote": true,
+          "endOfLine": "auto"
+        }
+      ]
+    },
+    "overrides": [
+      // Configuration for TypeScript files
+      {
+        "files": ["**/*.ts", "**/__tests__/*.test.ts"],
+        "plugins": [
+          "@typescript-eslint",
+          "unused-imports",
+          "simple-import-sort"
+        ],
+        "extends": [
+          "airbnb-typescript",
+          "plugin:prettier/recommended"
+        ],
+        "parserOptions": {
+          "project": "./tsconfig.json"
+        },
+        "rules": {
+          "prettier/prettier": [
+            "error",
+            {
+              "singleQuote": true,
+              "endOfLine": "auto"
+            }
+          ],
+          "@typescript-eslint/comma-dangle": "off", // Avoid conflict rule between Eslint and Prettier
+          "@typescript-eslint/consistent-type-imports": "error", // Ensure `import type` is used when it's necessary
+          "import/prefer-default-export": "off", // Named export is easier to refactor automatically
+          "simple-import-sort/imports": "error", // Import configuration for `eslint-plugin-simple-import-sort`
+          "simple-import-sort/exports": "error", // Export configuration for `eslint-plugin-simple-import-sort`
+          "@typescript-eslint/no-unused-vars": "off",
+          "react/jsx-filename-extension": "off", // Gives error
+          "unused-imports/no-unused-imports": "error",
+          "unused-imports/no-unused-vars": [
+            "error",
+            { "argsIgnorePattern": "^_" }
+          ]
+        }
+      }
+    ]
+  }
+  
@@ -0,0 +1,47 @@
+name: Node.js Package
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - run: npm ci
+      - run: npm test
+      - run: npm run build
+      - uses: actions/upload-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - uses: actions/upload-artifact@v3
+        with:
+          name: types
+          path: types
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          registry-url: https://registry.npmjs.org/
+      - uses: actions/download-artifact@v3
+        with:
+          name: dist
+          path: dist
+      - uses: actions/download-artifact@v3
+        with:
+          name: types
+          path: types
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
@@ -0,0 +1,138 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+.cache
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+.ideas.md
+.todos.md
+
+# Custom
+dist
+types
+build
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit $1
@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Disable concurent to run `check-types` after ESLint in lint-staged
+npx lint-staged --concurrent false
@@ -0,0 +1,8 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Singh"
+  given-names: "Taranjeet"
+title: "Embedchain"
+date-released: 2023-06-25
+url: "https://github.com/embedchain/embedchainjs"
@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
@@ -0,0 +1,263 @@
+# embedchainjs
+
+[![Discord](https://dcbadge.vercel.app/api/server/CUU9FPhRNt?style=flat)](https://discord.gg/CUU9FPhRNt)
+[![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/)
+
+embedchain is a framework to easily create LLM powered bots over any dataset. embedchainjs is Javascript version of embedchain. If you want a python version, check out [embedchain-python](https://github.com/embedchain/embedchain)
+
+# 🤝 Let's Talk Embedchain!
+
+Schedule a [Feedback Session](https://cal.com/taranjeetio/ec) with Taranjeet, the founder, to discuss any issues, provide feedback, or explore improvements.
+
+# How it works
+
+It abstracts the entire process of loading dataset, chunking it, creating embeddings and then storing in vector database.
+
+You can add a single or multiple dataset using `.add` and `.addLocal` function and then use `.query` function to find an answer from the added datasets.
+
+If you want to create a Naval Ravikant bot which has 2 of his blog posts, as well as a question and answer pair you supply, all you need to do is add the links to the blog posts and the QnA pair and embedchain will create a bot for you.
+
+```javascript
+const dotenv = require("dotenv");
+dotenv.config();
+const { App } = require("embedchain");
+
+//Run the app commands inside an async function only
+async function testApp() {
+  const navalChatBot = await App();
+
+  // Embed Online Resources
+  await navalChatBot.add("web_page", "https://nav.al/feedback");
+  await navalChatBot.add("web_page", "https://nav.al/agi");
+  await navalChatBot.add(
+    "pdf_file",
+    "https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf"
+  );
+
+  // Embed Local Resources
+  await navalChatBot.addLocal("qna_pair", [
+    "Who is Naval Ravikant?",
+    "Naval Ravikant is an Indian-American entrepreneur and investor.",
+  ]);
+
+  const result = await navalChatBot.query(
+    "What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?"
+  );
+  console.log(result);
+  // answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
+}
+
+testApp();
+```
+
+# Getting Started
+
+## Installation
+
+- First make sure that you have the package installed. If not, then install it using `npm`
+
+```bash
+npm install embedchain && npm install -S openai@^3.3.0
+```
+
+- Currently, it is only compatible with openai 3.X, not the latest version 4.X. Please make sure to use the right version, otherwise you will see the `ChromaDB` error `TypeError: OpenAIApi.Configuration is not a constructor`
+
+- Make sure that dotenv package is installed and your `OPENAI_API_KEY` in a file called `.env` in the root folder. You can install dotenv by
+
+```js
+npm install dotenv
+```
+
+- Download and install Docker on your device by visiting [this link](https://www.docker.com/). You will need this to run Chroma vector database on your machine.
+
+- Run the following commands to setup Chroma container in Docker
+
+```bash
+git clone https://github.com/chroma-core/chroma.git
+cd chroma
+docker-compose up -d --build
+```
+
+- Once Chroma container has been set up, run it inside Docker
+
+## Usage
+
+- We use 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 have dont 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`
+
+```js
+// Set this inside your .env file
+OPENAI_API_KEY = "sk-xxxx";
+```
+
+- Load the environment variables inside your .js file using the following commands
+
+```js
+const dotenv = require("dotenv");
+dotenv.config();
+```
+
+- Next import the `App` class from embedchain and use `.add` function to add any dataset.
+- Now your app is created. You can use `.query` function to get the answer for any query.
+
+```js
+const dotenv = require("dotenv");
+dotenv.config();
+const { App } = require("embedchain");
+
+async function testApp() {
+  const navalChatBot = await App();
+
+  // Embed Online Resources
+  await navalChatBot.add("web_page", "https://nav.al/feedback");
+  await navalChatBot.add("web_page", "https://nav.al/agi");
+  await navalChatBot.add(
+    "pdf_file",
+    "https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf"
+  );
+
+  // Embed Local Resources
+  await navalChatBot.addLocal("qna_pair", [
+    "Who is Naval Ravikant?",
+    "Naval Ravikant is an Indian-American entrepreneur and investor.",
+  ]);
+
+  const result = await navalChatBot.query(
+    "What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?"
+  );
+  console.log(result);
+  // answer: Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.
+}
+
+testApp();
+```
+
+- If there is any other app instance in your script or app, you can change the import as
+
+```javascript
+const { App: EmbedChainApp } = require("embedchain");
+
+// or
+
+const { App: ECApp } = require("embedchain");
+```
+
+## Format supported
+
+We support the following formats:
+
+### PDF File
+
+To add any pdf file, use the data_type as `pdf_file`. Eg:
+
+```javascript
+await app.add("pdf_file", "a_valid_url_where_pdf_file_can_be_accessed");
+```
+
+### Web Page
+
+To add any web page, use the data_type as `web_page`. Eg:
+
+```javascript
+await app.add("web_page", "a_valid_web_page_url");
+```
+
+### QnA Pair
+
+To supply your own QnA pair, use the data_type as `qna_pair` and enter a tuple. Eg:
+
+```javascript
+await app.addLocal("qna_pair", ["Question", "Answer"]);
+```
+
+### More Formats coming soon
+
+- If you want to add any other format, please create an [issue](https://github.com/embedchain/embedchainjs/issues) and we will add it to the list of supported formats.
+
+## Testing
+
+Before you consume valueable tokens, you should make sure that the embedding you have done works and that it's receiving the correct document from the database.
+
+For this you can use the `dryRun` method.
+
+Following the example above, add this to your script:
+
+```js
+let result = await naval_chat_bot.dryRun("What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?");console.log(result);
+
+'''
+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.
+terms of the unseen. And I think that’s critical. That is what humans do uniquely that no other creature, no other computer, no other intelligence—biological or artificial—that we have ever encountered does. And not only do we do it uniquely, but if we were to meet an alien species that also had the power to generate these good explanations, there is no explanation that they could generate that we could not understand. We are maximally capable of understanding. There is no concept out there that is possible in this physical reality that a human being, given sufficient time and resources and
+Query: What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?
+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.**
+
+# How does it work?
+
+Creating a chat bot over any dataset needs the following steps to happen
+
+- load the data
+- create meaningful chunks
+- create embeddings for each chunk
+- store the chunks in vector database
+
+Whenever a user asks any query, following process happens to find the answer for the query
+
+- create the embedding for query
+- find similar documents for this query from vector database
+- pass similar documents as context to LLM to get the final answer.
+
+The process of loading the dataset and then querying involves multiple steps and each steps has nuances of it is own.
+
+- 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 vector database? Which vector database should I use?
+- Should I store meta data along with the embeddings?
+- How should I find similar documents for a query? Which ranking model should I use?
+
+These questions may be trivial for some but for a lot of us, it needs research, experimentation and time to find out the accurate answers.
+
+embedchain is a framework which takes care of all these nuances and provides a simple interface to create bots over any dataset.
+
+In the first release, we are making it easier for anyone to get a chatbot over any dataset up and running in less than a minute. All you need to do is create an app instance, add the data sets using `.add` function and then use `.query` function to get the relevant answer.
+
+# Tech Stack
+
+embedchain is built on the following stack:
+
+- [Langchain](https://github.com/hwchase17/langchain) as an LLM framework to load, chunk and index data
+- [OpenAI's Ada embedding model](https://platform.openai.com/docs/guides/embeddings) to create embeddings
+- [OpenAI's ChatGPT API](https://platform.openai.com/docs/guides/gpt/chat-completions-api) as LLM to get answers given the context
+- [Chroma](https://github.com/chroma-core/chroma) as the vector database to store embeddings
+
+# Team
+
+## Author
+
+- Taranjeet Singh ([@taranjeetio](https://twitter.com/taranjeetio))
+
+## Maintainer
+
+- [cachho](https://github.com/cachho)
+- [sahilyadav902](https://github.com/sahilyadav902)
+
+## Citation
+
+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},
+  year = {2023},
+  publisher = {GitHub},
+  journal = {GitHub repository},
+  howpublished = {\url{https://github.com/embedchain/embedchainjs}},
+}
+```
@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };
@@ -0,0 +1,66 @@
+import { EmbedChainApp } from '../embedchain';
+
+const mockAdd = jest.fn();
+const mockAddLocal = jest.fn();
+const mockQuery = jest.fn();
+
+jest.mock('../embedchain', () => {
+  return {
+    EmbedChainApp: jest.fn().mockImplementation(() => {
+      return {
+        add: mockAdd,
+        addLocal: mockAddLocal,
+        query: mockQuery,
+      };
+    }),
+  };
+});
+
+describe('Test App', () => {
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+
+  it('tests the App', async () => {
+    mockQuery.mockResolvedValue(
+      'Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.'
+    );
+
+    const navalChatBot = await new EmbedChainApp(undefined, false);
+
+    // Embed Online Resources
+    await navalChatBot.add('web_page', 'https://nav.al/feedback');
+    await navalChatBot.add('web_page', 'https://nav.al/agi');
+    await navalChatBot.add(
+      'pdf_file',
+      'https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf'
+    );
+
+    // Embed Local Resources
+    await navalChatBot.addLocal('qna_pair', [
+      'Who is Naval Ravikant?',
+      'Naval Ravikant is an Indian-American entrepreneur and investor.',
+    ]);
+
+    const result = await navalChatBot.query(
+      'What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?'
+    );
+
+    expect(mockAdd).toHaveBeenCalledWith('web_page', 'https://nav.al/feedback');
+    expect(mockAdd).toHaveBeenCalledWith('web_page', 'https://nav.al/agi');
+    expect(mockAdd).toHaveBeenCalledWith(
+      'pdf_file',
+      'https://navalmanack.s3.amazonaws.com/Eric-Jorgenson_The-Almanack-of-Naval-Ravikant_Final.pdf'
+    );
+    expect(mockAddLocal).toHaveBeenCalledWith('qna_pair', [
+      'Who is Naval Ravikant?',
+      'Naval Ravikant is an Indian-American entrepreneur and investor.',
+    ]);
+    expect(mockQuery).toHaveBeenCalledWith(
+      'What unique capacity does Naval argue humans possess when it comes to understanding explanations or concepts?'
+    );
+    expect(result).toBe(
+      'Naval argues that humans possess the unique capacity to understand explanations or concepts to the maximum extent possible in this physical reality.'
+    );
+  });
+});
@@ -0,0 +1,44 @@
+import { createHash } from 'crypto';
+import type { RecursiveCharacterTextSplitter } from 'langchain/text_splitter';
+
+import type { BaseLoader } from '../loaders';
+import type { Input, LoaderResult } from '../models';
+import type { ChunkResult } from '../models/ChunkResult';
+
+class BaseChunker {
+  textSplitter: RecursiveCharacterTextSplitter;
+
+  constructor(textSplitter: RecursiveCharacterTextSplitter) {
+    this.textSplitter = textSplitter;
+  }
+
+  async createChunks(loader: BaseLoader, url: Input): Promise<ChunkResult> {
+    const documents: ChunkResult['documents'] = [];
+    const ids: ChunkResult['ids'] = [];
+    const datas: LoaderResult = await loader.loadData(url);
+    const metadatas: ChunkResult['metadatas'] = [];
+
+    const dataPromises = datas.map(async (data) => {
+      const { content, metaData } = data;
+      const chunks: string[] = await this.textSplitter.splitText(content);
+      chunks.forEach((chunk) => {
+        const chunkId = createHash('sha256')
+          .update(chunk + metaData.url)
+          .digest('hex');
+        ids.push(chunkId);
+        documents.push(chunk);
+        metadatas.push(metaData);
+      });
+    });
+
+    await Promise.all(dataPromises);
+
+    return {
+      documents,
+      ids,
+      metadatas,
+    };
+  }
+}
+
+export { BaseChunker };
@@ -0,0 +1,26 @@
+import { RecursiveCharacterTextSplitter } from 'langchain/text_splitter';
+
+import { BaseChunker } from './BaseChunker';
+
+interface TextSplitterChunkParams {
+  chunkSize: number;
+  chunkOverlap: number;
+  keepSeparator: boolean;
+}
+
+const TEXT_SPLITTER_CHUNK_PARAMS: TextSplitterChunkParams = {
+  chunkSize: 1000,
+  chunkOverlap: 0,
+  keepSeparator: false,
+};
+
+class PdfFileChunker extends BaseChunker {
+  constructor() {
+    const textSplitter = new RecursiveCharacterTextSplitter(
+      TEXT_SPLITTER_CHUNK_PARAMS
+    );
+    super(textSplitter);
+  }
+}
+
+export { PdfFileChunker };
@@ -0,0 +1,26 @@
+import { RecursiveCharacterTextSplitter } from 'langchain/text_splitter';
+
+import { BaseChunker } from './BaseChunker';
+
+interface TextSplitterChunkParams {
+  chunkSize: number;
+  chunkOverlap: number;
+  keepSeparator: boolean;
+}
+
+const TEXT_SPLITTER_CHUNK_PARAMS: TextSplitterChunkParams = {
+  chunkSize: 300,
+  chunkOverlap: 0,
+  keepSeparator: false,
+};
+
+class QnaPairChunker extends BaseChunker {
+  constructor() {
+    const textSplitter = new RecursiveCharacterTextSplitter(
+      TEXT_SPLITTER_CHUNK_PARAMS
+    );
+    super(textSplitter);
+  }
+}
+
+export { QnaPairChunker };
@@ -0,0 +1,26 @@
+import { RecursiveCharacterTextSplitter } from 'langchain/text_splitter';
+
+import { BaseChunker } from './BaseChunker';
+
+interface TextSplitterChunkParams {
+  chunkSize: number;
+  chunkOverlap: number;
+  keepSeparator: boolean;
+}
+
+const TEXT_SPLITTER_CHUNK_PARAMS: TextSplitterChunkParams = {
+  chunkSize: 500,
+  chunkOverlap: 0,
+  keepSeparator: false,
+};
+
+class WebPageChunker extends BaseChunker {
+  constructor() {
+    const textSplitter = new RecursiveCharacterTextSplitter(
+      TEXT_SPLITTER_CHUNK_PARAMS
+    );
+    super(textSplitter);
+  }
+}
+
+export { WebPageChunker };
@@ -0,0 +1,6 @@
+import { BaseChunker } from './BaseChunker';
+import { PdfFileChunker } from './PdfFile';
+import { QnaPairChunker } from './QnaPair';
+import { WebPageChunker } from './WebPage';
+
+export { BaseChunker, PdfFileChunker, QnaPairChunker, WebPageChunker };
@@ -0,0 +1,317 @@
+/* eslint-disable max-classes-per-file */
+import type { Collection } from 'chromadb';
+import type { QueryResponse } from 'chromadb/dist/main/types';
+import * as fs from 'fs';
+import { Document } from 'langchain/document';
+import OpenAI from 'openai';
+import * as path from 'path';
+import { v4 as uuidv4 } from 'uuid';
+
+import type { BaseChunker } from './chunkers';
+import { PdfFileChunker, QnaPairChunker, WebPageChunker } from './chunkers';
+import type { BaseLoader } from './loaders';
+import { LocalQnaPairLoader, PdfFileLoader, WebPageLoader } from './loaders';
+import type {
+  DataDict,
+  DataType,
+  FormattedResult,
+  Input,
+  LocalInput,
+  Metadata,
+  Method,
+  RemoteInput,
+} from './models';
+import { ChromaDB } from './vectordb';
+import type { BaseVectorDB } from './vectordb/BaseVectorDb';
+
+const openai = new OpenAI({
+  apiKey: process.env.OPENAI_API_KEY,
+});
+
+class EmbedChain {
+  dbClient: any;
+
+  // TODO: Definitely assign
+  collection!: Collection;
+
+  userAsks: [DataType, Input][] = [];
+
+  initApp: Promise<void>;
+
+  collectMetrics: boolean;
+
+  sId: string; // sessionId
+
+  constructor(db?: BaseVectorDB, collectMetrics: boolean = true) {
+    if (!db) {
+      this.initApp = this.setupChroma();
+    } else {
+      this.initApp = this.setupOther(db);
+    }
+
+    this.collectMetrics = collectMetrics;
+
+    // Send anonymous telemetry
+    this.sId = uuidv4();
+    this.sendTelemetryEvent('init');
+  }
+
+  async setupChroma(): Promise<void> {
+    const db = new ChromaDB();
+    await db.initDb;
+    this.dbClient = db.client;
+    if (db.collection) {
+      this.collection = db.collection;
+    } else {
+      // TODO: Add proper error handling
+      console.error('No collection');
+    }
+  }
+
+  async setupOther(db: BaseVectorDB): Promise<void> {
+    await db.initDb;
+    // TODO: Figure out how we can initialize an unknown database.
+    // this.dbClient = db.client;
+    // this.collection = db.collection;
+    this.userAsks = [];
+  }
+
+  static getLoader(dataType: DataType) {
+    const loaders: { [t in DataType]: BaseLoader } = {
+      pdf_file: new PdfFileLoader(),
+      web_page: new WebPageLoader(),
+      qna_pair: new LocalQnaPairLoader(),
+    };
+    return loaders[dataType];
+  }
+
+  static getChunker(dataType: DataType) {
+    const chunkers: { [t in DataType]: BaseChunker } = {
+      pdf_file: new PdfFileChunker(),
+      web_page: new WebPageChunker(),
+      qna_pair: new QnaPairChunker(),
+    };
+    return chunkers[dataType];
+  }
+
+  public async add(dataType: DataType, url: RemoteInput) {
+    const loader = EmbedChain.getLoader(dataType);
+    const chunker = EmbedChain.getChunker(dataType);
+    this.userAsks.push([dataType, url]);
+    const { documents, countNewChunks } = await this.loadAndEmbed(
+      loader,
+      chunker,
+      url
+    );
+
+    if (this.collectMetrics) {
+      const wordCount = documents.reduce(
+        (sum, document) => sum + document.split(' ').length,
+        0
+      );
+
+      this.sendTelemetryEvent('add', {
+        data_type: dataType,
+        word_count: wordCount,
+        chunks_count: countNewChunks,
+      });
+    }
+  }
+
+  public async addLocal(dataType: DataType, content: LocalInput) {
+    const loader = EmbedChain.getLoader(dataType);
+    const chunker = EmbedChain.getChunker(dataType);
+    this.userAsks.push([dataType, content]);
+    const { documents, countNewChunks } = await this.loadAndEmbed(
+      loader,
+      chunker,
+      content
+    );
+
+    if (this.collectMetrics) {
+      const wordCount = documents.reduce(
+        (sum, document) => sum + document.split(' ').length,
+        0
+      );
+
+      this.sendTelemetryEvent('add_local', {
+        data_type: dataType,
+        word_count: wordCount,
+        chunks_count: countNewChunks,
+      });
+    }
+  }
+
+  protected async loadAndEmbed(
+    loader: any,
+    chunker: BaseChunker,
+    src: Input
+  ): Promise<{
+    documents: string[];
+    metadatas: Metadata[];
+    ids: string[];
+    countNewChunks: number;
+  }> {
+    const embeddingsData = await chunker.createChunks(loader, src);
+    let { documents, ids, metadatas } = embeddingsData;
+
+    const existingDocs = await this.collection.get({ ids });
+    const existingIds = new Set(existingDocs.ids);
+
+    if (existingIds.size > 0) {
+      const dataDict: DataDict = {};
+      for (let i = 0; i < ids.length; i += 1) {
+        const id = ids[i];
+        if (!existingIds.has(id)) {
+          dataDict[id] = { doc: documents[i], meta: metadatas[i] };
+        }
+      }
+
+      if (Object.keys(dataDict).length === 0) {
+        console.log(`All data from ${src} already exists in the database.`);
+        return { documents: [], metadatas: [], ids: [], countNewChunks: 0 };
+      }
+      ids = Object.keys(dataDict);
+      const dataValues = Object.values(dataDict);
+      documents = dataValues.map(({ doc }) => doc);
+      metadatas = dataValues.map(({ meta }) => meta);
+    }
+
+    const countBeforeAddition = await this.count();
+    await this.collection.add({ documents, metadatas, ids });
+    const countNewChunks = (await this.count()) - countBeforeAddition;
+    console.log(
+      `Successfully saved ${src}. New chunks count: ${countNewChunks}`
+    );
+    return { documents, metadatas, ids, countNewChunks };
+  }
+
+  static async formatResult(
+    results: QueryResponse
+  ): Promise<FormattedResult[]> {
+    return results.documents[0].map((document: any, index: number) => {
+      const metadata = results.metadatas[0][index] || {};
+      // TODO: Add proper error handling
+      const distance = results.distances ? results.distances[0][index] : null;
+      return [new Document({ pageContent: document, metadata }), distance];
+    });
+  }
+
+  static async getOpenAiAnswer(prompt: string) {
+    const messages: OpenAI.Chat.CreateChatCompletionRequestMessage[] = [
+      { role: 'user', content: prompt },
+    ];
+    const response = await openai.chat.completions.create({
+      model: 'gpt-3.5-turbo',
+      messages,
+      temperature: 0,
+      max_tokens: 1000,
+      top_p: 1,
+    });
+    return (
+      response.choices[0].message?.content ?? 'Response could not be processed.'
+    );
+  }
+
+  protected async retrieveFromDatabase(inputQuery: string) {
+    const result = await this.collection.query({
+      nResults: 1,
+      queryTexts: [inputQuery],
+    });
+    const resultFormatted = await EmbedChain.formatResult(result);
+    const content = resultFormatted[0][0].pageContent;
+    return content;
+  }
+
+  static generatePrompt(inputQuery: string, context: any) {
+    const prompt = `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.\n${context}\nQuery: ${inputQuery}\nHelpful Answer:`;
+    return prompt;
+  }
+
+  static async getAnswerFromLlm(prompt: string) {
+    const answer = await EmbedChain.getOpenAiAnswer(prompt);
+    return answer;
+  }
+
+  public async query(inputQuery: string) {
+    const context = await this.retrieveFromDatabase(inputQuery);
+    const prompt = EmbedChain.generatePrompt(inputQuery, context);
+    const answer = await EmbedChain.getAnswerFromLlm(prompt);
+    this.sendTelemetryEvent('query');
+    return answer;
+  }
+
+  public async dryRun(input_query: string) {
+    const context = await this.retrieveFromDatabase(input_query);
+    const prompt = EmbedChain.generatePrompt(input_query, context);
+    return prompt;
+  }
+
+  /**
+   * Count the number of embeddings.
+   * @returns {Promise<number>}: The number of embeddings.
+   */
+  public count(): Promise<number> {
+    return this.collection.count();
+  }
+
+  protected async sendTelemetryEvent(method: Method, extraMetadata?: object) {
+    if (!this.collectMetrics) {
+      return;
+    }
+    const url = 'https://api.embedchain.ai/api/v1/telemetry/';
+
+    // Read package version from filesystem (because it's not in the ts root dir)
+    const packageJsonPath = path.join(__dirname, '..', 'package.json');
+    const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
+
+    const metadata = {
+      s_id: this.sId,
+      version: packageJson.version,
+      method,
+      language: 'js',
+      ...extraMetadata,
+    };
+
+    const maxRetries = 3;
+
+    // Retry the fetch
+    for (let i = 0; i < maxRetries; i += 1) {
+      try {
+        // eslint-disable-next-line no-await-in-loop
+        const response = await fetch(url, {
+          method: 'POST',
+          body: JSON.stringify({ metadata }),
+        });
+
+        if (response.ok) {
+          // Break out of the loop if the request was successful
+          break;
+        } else {
+          // Log the unsuccessful response (optional)
+          console.error(
+            `Telemetry: Attempt ${i + 1} failed with status:`,
+            response.status
+          );
+        }
+      } catch (error) {
+        // Log the error (optional)
+        console.error(`Telemetry: Attempt ${i + 1} failed with error:`, error);
+      }
+
+      // If this was the last attempt, throw an error or handle the failure
+      if (i === maxRetries - 1) {
+        console.error('Telemetry: Max retries reached');
+      }
+    }
+  }
+}
+
+class EmbedChainApp extends EmbedChain {
+  // The EmbedChain app.
+  // Has two functions: add and query.
+  // adds(dataType, url): adds the data from the given URL to the vector db.
+  // query(query): finds answer to the given query using vector database and LLM.
+}
+
+export { EmbedChainApp };
@@ -0,0 +1,7 @@
+import { EmbedChainApp } from './embedchain';
+
+export const App = async () => {
+  const app = new EmbedChainApp();
+  await app.initApp;
+  return app;
+};
@@ -0,0 +1,5 @@
+import type { Input, LoaderResult } from '../models';
+
+export abstract class BaseLoader {
+  abstract loadData(src: Input): Promise<LoaderResult>;
+}
@@ -0,0 +1,21 @@
+import type { LoaderResult, QnaPair } from '../models';
+import { BaseLoader } from './BaseLoader';
+
+class LocalQnaPairLoader extends BaseLoader {
+  // eslint-disable-next-line class-methods-use-this
+  async loadData(content: QnaPair): Promise<LoaderResult> {
+    const [question, answer] = content;
+    const contentText = `Q: ${question}\nA: ${answer}`;
+    const metaData = {
+      url: 'local',
+    };
+    return [
+      {
+        content: contentText,
+        metaData,
+      },
+    ];
+  }
+}
+
+export { LocalQnaPairLoader };
@@ -0,0 +1,58 @@
+import type { TextContent } from 'pdfjs-dist/types/src/display/api';
+
+import type { LoaderResult, Metadata } from '../models';
+import { cleanString } from '../utils';
+import { BaseLoader } from './BaseLoader';
+
+const pdfjsLib = require('pdfjs-dist');
+
+interface Page {
+  page_content: string;
+}
+
+class PdfFileLoader extends BaseLoader {
+  static async getPagesFromPdf(url: string): Promise<Page[]> {
+    const loadingTask = pdfjsLib.getDocument(url);
+    const pdf = await loadingTask.promise;
+    const { numPages } = pdf;
+
+    const promises = Array.from({ length: numPages }, async (_, i) => {
+      const page = await pdf.getPage(i + 1);
+      const pageText: TextContent = await page.getTextContent();
+      const pageContent: string = pageText.items
+        .map((item) => ('str' in item ? item.str : ''))
+        .join(' ');
+
+      return {
+        page_content: pageContent,
+      };
+    });
+
+    return Promise.all(promises);
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  async loadData(url: string): Promise<LoaderResult> {
+    const pages: Page[] = await PdfFileLoader.getPagesFromPdf(url);
+    const output: LoaderResult = [];
+
+    if (!pages.length) {
+      throw new Error('No data found');
+    }
+
+    pages.forEach((page) => {
+      let content: string = page.page_content;
+      content = cleanString(content);
+      const metaData: Metadata = {
+        url,
+      };
+      output.push({
+        content,
+        metaData,
+      });
+    });
+    return output;
+  }
+}
+
+export { PdfFileLoader };
@@ -0,0 +1,51 @@
+import axios from 'axios';
+import { JSDOM } from 'jsdom';
+
+import { cleanString } from '../utils';
+import { BaseLoader } from './BaseLoader';
+
+class WebPageLoader extends BaseLoader {
+  // eslint-disable-next-line class-methods-use-this
+  async loadData(url: string) {
+    const response = await axios.get(url);
+    const html = response.data;
+    const dom = new JSDOM(html);
+    const { document } = dom.window;
+    const unwantedTags = [
+      'nav',
+      'aside',
+      'form',
+      'header',
+      'noscript',
+      'svg',
+      'canvas',
+      'footer',
+      'script',
+      'style',
+    ];
+    unwantedTags.forEach((tagName) => {
+      const elements = document.getElementsByTagName(tagName);
+      Array.from(elements).forEach((element) => {
+        // eslint-disable-next-line no-param-reassign
+        (element as HTMLElement).textContent = ' ';
+      });
+    });
+
+    const output = [];
+    let content = document.body.textContent;
+    if (!content) {
+      throw new Error('Web page content is empty.');
+    }
+    content = cleanString(content);
+    const metaData = {
+      url,
+    };
+    output.push({
+      content,
+      metaData,
+    });
+    return output;
+  }
+}
+
+export { WebPageLoader };
@@ -0,0 +1,6 @@
+import { BaseLoader } from './BaseLoader';
+import { LocalQnaPairLoader } from './LocalQnaPair';
+import { PdfFileLoader } from './PdfFile';
+import { WebPageLoader } from './WebPage';
+
+export { BaseLoader, LocalQnaPairLoader, PdfFileLoader, WebPageLoader };
@@ -0,0 +1,7 @@
+import type { Metadata } from './Metadata';
+
+export type ChunkResult = {
+  documents: string[];
+  ids: string[];
+  metadatas: Metadata[];
+};
@@ -0,0 +1,10 @@
+import type { ChunkResult } from './ChunkResult';
+
+type Data = {
+  doc: ChunkResult['documents'][0];
+  meta: ChunkResult['metadatas'][0];
+};
+
+export type DataDict = {
+  [id: string]: Data;
+};
@@ -0,0 +1 @@
+export type DataType = 'pdf_file' | 'web_page' | 'qna_pair';
@@ -0,0 +1,3 @@
+import type { Document } from 'langchain/document';
+
+export type FormattedResult = [Document, number | null];
@@ -0,0 +1,7 @@
+import type { QnaPair } from './QnAPair';
+
+export type RemoteInput = string;
+
+export type LocalInput = QnaPair;
+
+export type Input = RemoteInput | LocalInput;
@@ -0,0 +1,3 @@
+import type { Metadata } from './Metadata';
+
+export type LoaderResult = { content: any; metaData: Metadata }[];
@@ -0,0 +1,3 @@
+export type Metadata = {
+  url: string;
+};
@@ -0,0 +1 @@
+export type Method = 'init' | 'query' | 'add' | 'add_local';
@@ -0,0 +1,4 @@
+type Question = string;
+type Answer = string;
+
+export type QnaPair = [Question, Answer];
@@ -0,0 +1,21 @@
+import { DataDict } from './DataDict';
+import { DataType } from './DataType';
+import { FormattedResult } from './FormattedResult';
+import { Input, LocalInput, RemoteInput } from './Input';
+import { LoaderResult } from './LoaderResult';
+import { Metadata } from './Metadata';
+import { Method } from './Method';
+import { QnaPair } from './QnAPair';
+
+export {
+  DataDict,
+  DataType,
+  FormattedResult,
+  Input,
+  LoaderResult,
+  LocalInput,
+  Metadata,
+  Method,
+  QnaPair,
+  RemoteInput,
+};
@@ -0,0 +1,26 @@
+/**
+ * This function takes in a string and performs a series of text cleaning operations.
+ * @param {str} text: The text to be cleaned. This is expected to be a string.
+ * @returns {str}: The cleaned text after all the cleaning operations have been performed.
+ */
+export function cleanString(text: string): string {
+  // Replacement of newline characters:
+  let cleanedText = text.replace(/\n/g, ' ');
+
+  // Stripping and reducing multiple spaces to single:
+  cleanedText = cleanedText.trim().replace(/\s+/g, ' ');
+
+  // Removing backslashes:
+  cleanedText = cleanedText.replace(/\\/g, '');
+
+  // Replacing hash characters:
+  cleanedText = cleanedText.replace(/#/g, ' ');
+
+  // Eliminating consecutive non-alphanumeric characters:
+  // This regex identifies consecutive non-alphanumeric characters (i.e., not a word character [a-zA-Z0-9_] and not a whitespace) in the string
+  // and replaces each group of such characters with a single occurrence of that character.
+  // For example, "!!! hello !!!" would become "! hello !".
+  cleanedText = cleanedText.replace(/([^\w\s])\1*/g, '$1');
+
+  return cleanedText;
+}
@@ -0,0 +1,14 @@
+class BaseVectorDB {
+  initDb: Promise<void>;
+
+  constructor() {
+    this.initDb = this.getClientAndCollection();
+  }
+
+  // eslint-disable-next-line class-methods-use-this
+  protected async getClientAndCollection(): Promise<void> {
+    throw new Error('getClientAndCollection() method is not implemented');
+  }
+}
+
+export { BaseVectorDB };
@@ -0,0 +1,38 @@
+import type { Collection } from 'chromadb';
+import { ChromaClient, OpenAIEmbeddingFunction } from 'chromadb';
+
+import { BaseVectorDB } from './BaseVectorDb';
+
+const embedder = new OpenAIEmbeddingFunction({
+  openai_api_key: process.env.OPENAI_API_KEY ?? '',
+});
+
+class ChromaDB extends BaseVectorDB {
+  client: ChromaClient | undefined;
+
+  collection: Collection | null = null;
+
+  // eslint-disable-next-line @typescript-eslint/no-useless-constructor
+  constructor() {
+    super();
+  }
+
+  protected async getClientAndCollection(): Promise<void> {
+    this.client = new ChromaClient({ path: 'http://localhost:8000' });
+    try {
+      this.collection = await this.client.getCollection({
+        name: 'embedchain_store',
+        embeddingFunction: embedder,
+      });
+    } catch (err) {
+      if (!this.collection) {
+        this.collection = await this.client.createCollection({
+          name: 'embedchain_store',
+          embeddingFunction: embedder,
+        });
+      }
+    }
+  }
+}
+
+export { ChromaDB };
@@ -0,0 +1,3 @@
+import { ChromaDB } from './ChromaDb';
+
+export { ChromaDB };
--- a/Show More
+++ b/Show More
Author	SHA1	Message	Date
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
Deshraj Yadav	333eb8d60f	Update version to 0.0.62 (#726 )	2023-09-28 15:03:20 -07:00
Deshraj Yadav	414c69fd62	Add support for OpenSearch as vector database (#725 )	2023-09-29 03:24:42 +05:30
Prikshit	9951b58005	Rename _get_azure_openai_answer to _get_answer (#724 )	2023-09-29 00:13:49 +05:30
Osama Nabih	e73ed82ae9	chore: Renamed EmbeddingFunctions.py to follow snakecase convention (#669 ) Signed-off-by: Osama Nabih <nabih_the_4th@yahoo.com>	2023-09-28 11:35:10 +05:30
Tushar kalsi	8bde34a24f	Fix #718 Added Slack in Mint.Js (#720 )	2023-09-28 11:32:33 +05:30
Taranjeet Singh	b58380e505	docs: add langsmith integration. (#717 )	2023-09-28 03:16:53 +05:30
Ayush Mishra	16f8de810c	Chore/follow_snake_conventions_in_config (#716 )	2023-09-27 21:38:42 +05:30
Taranjeet Singh	70f2de4fd3	feat: bump version to 0.0.61 (#709 )	2023-09-27 10:53:26 +05:30
Subhajit Ghosh	a5d5e5825f	Renamed apps/App.py to follow snake case convention (#708 )	2023-09-27 10:35:22 +05:30
Taranjeet Singh	0f16c72762	fix: use openai llm via langchain (#670 ) Co-authored-by: Deshraj Yadav <deshrajdry@gmail.com>	2023-09-27 10:34:02 +05:30
Subhajit Ghosh	9ca7a0d6d1	Rename models/Providers.py to follow snake case convention (#707 )	2023-09-27 10:31:08 +05:30
Subhajit Ghosh	7d5bfd8c9f	Renamed models/VectorDimensions.py to follow snake case convention (#706 )	2023-09-27 10:15:28 +05:30
Taranjeet Singh	cc9a06b116	feat: bump version to 0.0.60 (#704 )	2023-09-27 10:03:31 +05:30
Subhajit Ghosh	b8fc7b0c9e	Renamed models/VectorDatabases.py to follow snake case convention (#703 )	2023-09-27 09:56:11 +05:30
Subhajit Ghosh	3999f2a373	Renamed config/apps/OpenSourceAppConfig.py to follow snake case convention (#701 )	2023-09-27 09:37:31 +05:30
Subhajit Ghosh	4eb2c0e123	Renamed apps/CustomApp.py to follow snake case convention (#678 )	2023-09-27 04:59:46 +05:30
Ayush Mishra	b8a838aee1	Remove load_and_embed_v1 method since it is not used (#638 )	2023-09-27 04:58:49 +05:30
Kapil Mirchandani	84e5932ea5	Rename BaseAppConfig to be snake_case (#689 )	2023-09-27 02:36:58 +05:30
Shubham Pal	e41573ca74	Fix: Added docx2txt dependency (#682 ) Co-authored-by: Taranjeet Singh <reachtotj@gmail.com>	2023-09-27 02:00:38 +05:30
Kapil Mirchandani	4c5c99e6ae	Rename CustomAppConfig to be snake_case (#680 )	2023-09-27 01:24:39 +05:30
Shivam Menda	dcb940ba95	Refactored AppConfig.py to app_config.py (#681 )	2023-09-26 23:54:42 +05:30
Subhajit Ghosh	8d3b66f7e3	Converted OpenSourceApp.py file name to Open_Source_App.py (#675 )	2023-09-25 23:17:53 -07:00
Deshraj Yadav	bc89b6ea74	Bump version to 0.0.59 (#651 )	2023-09-24 18:15:29 -07:00
sw8fbar	f0742dffa2	Docs: where context filter (#547 )	2023-09-24 13:32:27 -07:00
cachho	6c71a1020d	Docs: use LlmConfig instead of QueryConfig (#626 )	2023-09-24 11:48:03 -07:00
Dev Khant	1db3e43adf	Add support for `dry_run` in `load_and_embed_v2` method (#634 )	2023-09-24 11:42:14 -07:00
Ayush Mishra	cb59b0b5e4	Bump embedchain package version in examples (#639 )	2023-09-24 09:53:06 -07:00
Dev Khant	8e0f05055e	Add chat feature to discord_bot example (#643 )	2023-09-24 09:49:59 -07:00
Naman Jain	4768bacf1c	docs: large csv file error (#644 )	2023-09-24 09:48:36 -07:00
Raghav Tyagi	dc206c0999	Fixed minor grammatical issues in documentation: Interface Types (#648 )	2023-09-24 09:47:47 -07:00
Dev Khant	77e1983b2e	bug: app.online fixed (#647 )	2023-09-23 16:10:18 -07:00
Dev Khant	d344ee226c	Set telemetry flag as a top level attribute (#462 )	2023-09-18 10:29:14 +05:30
cachho	3d0e4141bf	refactor: get existing doc id method (#616 )	2023-09-17 23:22:12 +05:30
Dev Khant	01fb216ff7	allow_reset as constructor argument (#618 )	2023-09-15 07:26:02 -07:00
David Talson	a662b2a6c6	change app.count to app.db.count (#620 )	2023-09-14 19:39:57 -07:00
Subhadip Mandal	b1af82eba8	Changed Tesla url to Forbes Url (#615 ) Co-authored-by: Subhadip <mnhacker2001@gmail.com>	2023-09-14 08:57:41 +05:30
Taranjeet Singh	378ef5246e	feat: bump version to 0.0.58 (#617 )	2023-09-14 02:20:31 +05:30
Lovepreet Singh	606814f10e	Fix a typo - accpeting -> accepting (#614 )	2023-09-14 02:07:06 +05:30
David Talson	5e06a0d001	Fix/dont print the entire text when data type is text (#605 )	2023-09-14 02:06:23 +05:30
cachho	c0e3274375	Fix/chat (#609 )	2023-09-14 02:04:27 +05:30
cachho	119ec5e405	fix: elastic search (#600 )	2023-09-13 23:28:18 +05:30
cachho	79efa51941	fix: url metadata for all datatypes (#613 )	2023-09-13 10:19:48 -07:00
Deshraj Yadav	701d0b21ef	[chore] fix lint issues (#607 )	2023-09-12 20:04:31 -07:00
Taranjeet Singh	0f23d5f967	feat: bump version to 0.0.57 (#606 )	2023-09-13 08:17:54 +05:30
Taranjeet Singh	36b26e08c3	feat: add support for mdx file (#604 )	2023-09-13 05:13:18 +05:30
cachho	ac08638a63	fix: do not mock get (#598 )	2023-09-12 22:42:17 +05:30
cachho	03146946fa	chore: linting (#597 )	2023-09-12 21:34:38 +05:30
cachho	0f9a10c598	fix: use template from tempory `LlmConfig` (#590 )	2023-09-12 21:33:58 +05:30
Taranjeet Singh	2bd6881361	feat: Add embedding manager (#570 )	2023-09-12 12:13:53 +05:30
Taranjeet Singh	ba208f5b48	feature: bump version to 0.0.56 (#595 )	2023-09-12 09:52:01 +05:30
Dev Khant	bdef85f7db	Handle if no module found for bots (#564 ) Co-authored-by: Taranjeet Singh <reachtotj@gmail.com>	2023-09-12 09:29:35 +05:30
cachho	2cb47938fd	fix: llama2 - use config with specific defaults (#594 )	2023-09-12 09:28:42 +05:30
cachho	dfe0b414ac	refactor: use llama hub instead of llama index (#592 )	2023-09-12 09:26:58 +05:30
cachho	1864f4cb38	fix: serialize non serializable (#589 )	2023-09-12 09:25:46 +05:30
Dev Khant	7c39d9f0c1	Add dry_run to add() (#545 )	2023-09-12 09:20:31 +05:30
Deshraj Yadav	79f5a1d052	[chore]: Rename modules for better readability and maintainability (#587 )	2023-09-11 07:01:40 +05:30
Deshraj Yadav	6fed75bb45	Remove elasticsearch as mandatory dependency (#585 )	2023-09-09 22:20:24 -07:00
Taranjeet Singh	352ed3b6a1	fix: update slack link (#583 )	2023-09-10 04:46:18 +05:30
Taranjeet Singh	b37691711c	feat: add slack community (#582 )	2023-09-10 04:43:49 +05:30
Dev Khant	13fda2efe1	fix: --upgrade flag for all pip instances (#557 )	2023-09-08 08:12:55 +05:30
Taranjeet Singh	3c3d98b9c3	feat: add embedchain javascript package (#576 )	2023-09-07 05:52:44 +05:30
				`@@ -0,0 +1 @@`
				`module.exports = { extends: ['@commitlint/config-conventional'] };`
				`@@ -0,0 +1 @@`
				`export type DataType = 'pdf_file' \| 'web_page' \| 'qna_pair';`
				`@@ -0,0 +1 @@`
				`export type Method = 'init' \| 'query' \| 'add' \| 'add_local';`