From 325e11f0deaf98504649d7161ca824e7a90f3416 Mon Sep 17 00:00:00 2001 From: Deshraj Yadav Date: Sun, 14 Jan 2024 12:09:40 +0530 Subject: [PATCH] Update docs (#1170) --- docs/components/data-sources/pdf-file.mdx | 9 +-------- .../data-sources/youtube-channel.mdx | 8 +++++--- .../components/data-sources/youtube-video.mdx | 10 ++++++++++ docs/mint.json | 20 +++++++++---------- 4 files changed, 26 insertions(+), 21 deletions(-) diff --git a/docs/components/data-sources/pdf-file.mdx b/docs/components/data-sources/pdf-file.mdx index 6ba45928..9cc45910 100644 --- a/docs/components/data-sources/pdf-file.mdx +++ b/docs/components/data-sources/pdf-file.mdx @@ -4,13 +4,6 @@ title: '📰 PDF' 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 ### 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.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. -# Contexts: +# Contexts: # [ # ( # 'Provided proper attribution is ...', diff --git a/docs/components/data-sources/youtube-channel.mdx b/docs/components/data-sources/youtube-channel.mdx index 543e20e0..1461413e 100644 --- a/docs/components/data-sources/youtube-channel.mdx +++ b/docs/components/data-sources/youtube-channel.mdx @@ -2,15 +2,17 @@ title: '📽️ Youtube Channel' --- -To add all the videos from a youtube channel to your app, use the data_type as `youtube_channel`. +## 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 all the videos from a youtube channel to your app, use the data_type as `youtube_channel`. ```python from embedchain import App diff --git a/docs/components/data-sources/youtube-video.mdx b/docs/components/data-sources/youtube-video.mdx index d3171057..c8e62d6f 100644 --- a/docs/components/data-sources/youtube-video.mdx +++ b/docs/components/data-sources/youtube-video.mdx @@ -2,6 +2,16 @@ 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: ```python diff --git a/docs/mint.json b/docs/mint.json index 3ea46ece..7cc922e9 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -199,18 +199,18 @@ { "group": "API Reference", "pages": [ - "api-reference/pipeline/overview", + "api-reference/app/overview", { - "group": "Pipeline methods", + "group": "App methods", "pages": [ - "api-reference/pipeline/add", - "api-reference/pipeline/query", - "api-reference/pipeline/chat", - "api-reference/pipeline/search", - "api-reference/pipeline/deploy", - "api-reference/pipeline/reset", - "api-reference/pipeline/delete", - "api-reference/pipeline/evaluate" + "api-reference/app/add", + "api-reference/app/query", + "api-reference/app/chat", + "api-reference/app/search", + "api-reference/app/deploy", + "api-reference/app/reset", + "api-reference/app/delete", + "api-reference/app/evaluate" ] }, "api-reference/store/openai-assistant",