Skip to content

Update README.md #104

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #104

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
42 changes: 27 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ Features:
Install the package using your preferred package manager:

```sh
pnpm add @upstash/rag-chat
pnpm add @upstash/rag-chat @upstash/redis

bun add @upstash/rag-chat
bun add @upstash/rag-chat @upstash/redis

npm i @upstash/rag-chat
npm i @upstash/rag-chat @upstash/redis
```

### Quick Start
Expand Down Expand Up @@ -66,8 +66,14 @@ import { RAGChat } from "@upstash/rag-chat";

const ragChat = new RAGChat();

const response = await ragChat.chat("Tell me about machine learning");
console.log(response);
const main = async ()=>{
const response = await ragChat.chat("Tell me about machine learning");
console.log(response);
}

main()


```

### Basic Usage
Expand All @@ -79,18 +85,24 @@ export const ragChat = new RAGChat({
model: openai("gpt-4-turbo"),
});

await ragChat.context.add({
type: "text",
data: "The speed of light is approximately 299,792,458 meters per second.",
});

await ragChat.context.add({
type: "pdf",
fileSource: "./data/physics_basics.pdf",
});
const response = await ragChat.chat("What is the speed of light?");
const main = async ()=>{

await ragChat.context.add({
type: "text",
data: "The speed of light is approximately 299,792,458 meters per second.",
});

await ragChat.context.add({
type: "pdf",
fileSource: "./data/physics_basics.pdf",
});
const response = await ragChat.chat("What is the speed of light?");

console.log(response.output);
}

console.log(response.output);
main()
```

## Docs
Expand Down