Skip to content

Fixed docs for FAQs and RAG API #203

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adhityan merged 2 commits into from
Jan 16, 2025
Merged

Fixed docs for FAQs and RAG API #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cae5dce
docs: fixed query signature and added an example
punkish Jan 9, 2025
60881a4
docs: fixed FAQs
punkish Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api-reference/methods/query.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Function signature is given below:
<ParamField path="userQuery" type="string" required>
Question to ask
</ParamField>
<ParamField path="conversationId" type="bool" optional>
<ParamField path="conversationId" type="string" optional>
The conversation ID to which the query belongs in case this is a chatbot scenario
</ParamField>
<ParamField path="customContext" type="Chunk[]" optional>
Expand Down Expand Up @@ -90,6 +90,7 @@ ragApplication.addLoader({ urlOrContent: 'https://www.forbes.com/profile/elon-mu
ragApplication.addLoader({ urlOrContent: 'https://en.wikipedia.org/wiki/Elon_Musk' })

await ragApplication.query('What is the net worth of Elon Musk today?')
await ragApplication.query('Who is Elon Musk?' { conversationId: '1' })
/*

*/
Expand Down
3 changes: 2 additions & 1 deletion docs/get-started/faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ description: 'Collections of all the frequently asked questions'
---
<AccordionGroup>
<Accordion title="How to use MistralAI language model?">
Use the model `gpt-4o` provided my openai.

<CodeGroup>
```ts index.ts
Expand All @@ -27,6 +26,8 @@ console.log(await llmApplication.query('Who founded Tesla?'));
</Accordion>

<Accordion title="How to use GPT-4o as the Language model?">
Use the model `gpt-4o` provided my openai.

<CodeGroup>
```ts index.ts
import 'dotenv/config';
Expand Down
Loading