-
Notifications
You must be signed in to change notification settings - Fork 252
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
91 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
Our Go SDK is still under development. We welcome contributions and beta testers for it! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# R2R JavaScript SDK Documentation | ||
|
||
For the complete look at the R2R JavaScript SDK, [visit our documentation.](https://r2r-docs.sciphi.ai/documentation/js-sdk/introduction) | ||
|
||
## Installation | ||
|
||
Before starting, make sure you have completed the [R2R installation](/documentation/installation). | ||
|
||
Install the R2R JavaScript SDK: | ||
|
||
```bash | ||
npm install r2r-js | ||
``` | ||
|
||
## Getting Started | ||
|
||
1. Import the R2R client: | ||
|
||
```javascript | ||
const { r2rClient } = require('r2r-js'); | ||
``` | ||
|
||
2. Initialize the client: | ||
|
||
```javascript | ||
const client = new r2rClient('http://localhost:8000'); | ||
``` | ||
|
||
3. Check if R2R is running correctly: | ||
|
||
```javascript | ||
const healthResponse = await client.health(); | ||
// {"status":"ok"} | ||
``` | ||
|
||
4. Login (Optional): | ||
```javascript | ||
// client.register("[email protected]", "my_password"), | ||
// client.verify_email("[email protected]", "my_verification_code") | ||
client.login("[email protected]", "my_password") | ||
``` | ||
When using authentication the commands below automatically restrict the scope to a user's available documents. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# R2R Python SDK Documentation | ||
|
||
For the complete look at the R2R Python SDK, [visit our documentation.](https://r2r-docs.sciphi.ai/documentation/python-sdk/introduction) | ||
|
||
## Installation | ||
|
||
Before starting, make sure you have completed the [R2R installation](/documentation/installation). | ||
|
||
Install the R2R Python SDK: | ||
|
||
```bash | ||
pip install r2r | ||
``` | ||
|
||
## Getting Started | ||
|
||
1. Import the R2R client: | ||
|
||
```python | ||
from r2r import R2RClient | ||
``` | ||
|
||
2. Initialize the client: | ||
|
||
```python | ||
client = R2RClient("http://localhost:8000") | ||
``` | ||
|
||
|
||
3. Check if R2R is running correctly: | ||
|
||
```python | ||
health_response = client.health() | ||
# {"status":"ok"} | ||
``` | ||
|
||
4. Login (Optional): | ||
```python | ||
# client.register("[email protected]", "my_password") | ||
# client.verify_email("[email protected]", "my_verification_code") | ||
client.login("[email protected]", "my_password") | ||
``` | ||
When using authentication the commands below automatically restrict the scope to a user's available documents. |