Update docs (#1170)

This commit is contained in:
Deshraj Yadav
2024-01-14 12:09:40 +05:30
committed by GitHub
parent 7444f59e3c
commit 325e11f0de
4 changed files with 26 additions and 21 deletions

View File

@@ -4,13 +4,6 @@ title: '📰 PDF'
You can load any pdf file from your local file system or through a URL. You can load any pdf file from your local file system or through a URL.
## Setup
Install the following packages for loading youtube videos which help in transcription.
```bash
pip install pytube youtube-transcript-api
```
## Usage ## Usage
### Load from a local file ### Load from a local file
@@ -29,7 +22,7 @@ app = App()
app.add('https://arxiv.org/pdf/1706.03762.pdf', data_type='pdf_file') 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?", citations=True) app.query("What is the paper 'attention is all you need' about?", citations=True)
# 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 that complex recurrent or convolutional neural networks can be replaced with a simpler architecture that connects the encoder and decoder through attention. The paper discusses how this approach can improve sequence transduction models, such as neural machine translation. # 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 that complex recurrent or convolutional neural networks can be replaced with a simpler architecture that connects the encoder and decoder through attention. The paper discusses how this approach can improve sequence transduction models, such as neural machine translation.
# Contexts: # Contexts:
# [ # [
# ( # (
# 'Provided proper attribution is ...', # 'Provided proper attribution is ...',

View File

@@ -2,15 +2,17 @@
title: '📽️ Youtube Channel' title: '📽️ Youtube Channel'
--- ---
To add all the videos from a youtube channel to your app, use the data_type as `youtube_channel`. ## Setup
<Note>
Make sure you have all the required packages installed before using this data type. You can install them by running the following command in your terminal. Make sure you have all the required packages installed before using this data type. You can install them by running the following command in your terminal.
```bash ```bash
pip install -u "embedchain[youtube]" pip install -u "embedchain[youtube]"
``` ```
</Note>
## Usage
To add all the videos from a youtube channel to your app, use the data_type as `youtube_channel`.
```python ```python
from embedchain import App from embedchain import App

View File

@@ -2,6 +2,16 @@
title: '📺 Youtube Video' title: '📺 Youtube Video'
--- ---
## Setup
Make sure you have all the required packages installed before using this data type. You can install them by running the following command in your terminal.
```bash
pip install -u "embedchain[youtube]"
```
## Usage
To add any youtube video to your app, use the data_type as `youtube_video`. Eg: To add any youtube video to your app, use the data_type as `youtube_video`. Eg:
```python ```python

View File

@@ -199,18 +199,18 @@
{ {
"group": "API Reference", "group": "API Reference",
"pages": [ "pages": [
"api-reference/pipeline/overview", "api-reference/app/overview",
{ {
"group": "Pipeline methods", "group": "App methods",
"pages": [ "pages": [
"api-reference/pipeline/add", "api-reference/app/add",
"api-reference/pipeline/query", "api-reference/app/query",
"api-reference/pipeline/chat", "api-reference/app/chat",
"api-reference/pipeline/search", "api-reference/app/search",
"api-reference/pipeline/deploy", "api-reference/app/deploy",
"api-reference/pipeline/reset", "api-reference/app/reset",
"api-reference/pipeline/delete", "api-reference/app/delete",
"api-reference/pipeline/evaluate" "api-reference/app/evaluate"
] ]
}, },
"api-reference/store/openai-assistant", "api-reference/store/openai-assistant",