Skip to content

Commit 3b8a073

Browse files
committed
docs: Fixed text
1 parent ed0ef97 commit 3b8a073

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
- [Installation](#Installation) 💿
1616
- [Examples](#examples-tldr) 🗂️
1717
- [AI21 Official Documentation](#Documentation)
18-
- [Chat](#Chat-Usage)
19-
- [Conversational RAG (Beta)](#Conversational-RAG-Usage)
20-
- [Files](#Files-Usage)
18+
- [Chat](#Chat)
19+
- [Conversational RAG (Beta)](#Conversational-RAG)
20+
- [Files](#Files)
2121

2222

2323
The AI21 API Client is a TypeScript library that provides a convenient interface for interacting with the AI21 API. It abstracts away the low-level details of making API requests and handling responses, allowing developers to focus on building their applications.
@@ -38,20 +38,18 @@ yarn add ai21
3838

3939
## Examples (tl;dr)
4040

41-
If you want to quickly get a glance how to use the AI21 Python SDK and jump straight to business, you can check out the examples. Take a look at our models and see them in action! Several examples and demonstrations have been put together to show our models' functionality and capabilities.
41+
If you want to quickly get a glance how to use the AI21 Typescript SDK and jump straight to business, you can check out the examples. Take a look at our models and see them in action! Several examples and demonstrations have been put together to show our models' functionality and capabilities.
4242

4343
### [Check out the Examples](examples/)
4444

4545
Feel free to dive in, experiment, and adapt these examples to suit your needs. We believe they'll help you get up and running quickly.
4646

4747
## Documentation
4848

49-
---
50-
5149
The full documentation for the REST API can be found on [docs.ai21.com](https://docs.ai21.com/).
5250

5351

54-
## Chat-Usage
52+
## Chat
5553

5654
To use the AI21 API Client, you'll need to have an API key. You can obtain an API key by signing up for an account on the AI21 website.
5755

@@ -92,7 +90,7 @@ for await (const chunk of streamResponse) {
9290
}
9391
```
9492
---
95-
### Files-Usage
93+
### Files
9694

9795

9896
The `AI21` class provides a `files` property that gives you access to the Files API. You can use it to upload, retrieve, update, list, and delete files.
@@ -117,7 +115,7 @@ const file = await client.files.get(fileUploadResponse.fileId);
117115
```
118116

119117
---
120-
### Conversational-RAG-Usage
118+
### Conversational-RAG
121119

122120

123121
The `AI21` class provides a `conversationalRag` property that gives you access to the Conversational RAG API. You can use it to ask questions that are answered based on the files you uploaded.
@@ -145,6 +143,7 @@ The `AI21` class accepts several configuration options, which you can pass in wh
145143
- `apiKey`: Your AI21 API Key
146144
- `maxRetries`: The maximum number of retries for failed requests (default: `3`)
147145
- `timeout`: The request timeout in seconds
146+
- `dangerouslyAllowBrowser`: Set to `true` to allow the client to be used in a browser environment.
148147

149148
## API Reference
150149

0 commit comments

Comments
 (0)