Skip to content

Commit

Permalink
up
Browse files Browse the repository at this point in the history
  • Loading branch information
emrgnt-cmplxty committed Aug 24, 2024
2 parents 15a17a5 + 00d6c19 commit cf78793
Show file tree
Hide file tree
Showing 6 changed files with 91 additions and 5 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on:

jobs:
build-and-publish:
runs-on: ubuntu-latest
runs-on: [ self-hosted, Linux ]
permissions:
packages: write
contents: read
Expand Down Expand Up @@ -66,7 +66,7 @@ jobs:
- name: Build and Push Docker Image
uses: docker/build-push-action@v5
with:
context: .
context: ./py
file: ./py/Dockerfile
push: true
tags: ${{ steps.meta.outputs.tags }}
Expand All @@ -76,7 +76,7 @@ jobs:
- name: Build and Push Docker Image
uses: docker/build-push-action@v5
with:
context: .
context: ./py
file: ./py/Dockerfile.unstructured
push: true
tags: ${{ steps.meta.outputs.tags }}-unstructured
Expand Down
1 change: 1 addition & 0 deletions go/README.md
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!
42 changes: 42 additions & 0 deletions js/README.md
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.
2 changes: 1 addition & 1 deletion py/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-purple.svg" alt="License: MIT"></a>
</p>

<img src="https://raw.githubusercontent.com/SciPhi-AI/R2R/dev/assets/r2r.png" alt="R2R Answer Engine">
<img width="1041" alt="r2r" src="https://github.com/user-attachments/assets/b6ee6a78-5d37-496d-ae10-ce18eee7a1d6">
<h3 align="center">
Build, scale, and manage user-facing Retrieval-Augmented Generation applications in production.
</h3>
Expand Down
2 changes: 1 addition & 1 deletion py/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ networks:

services:
r2r:
image: ${R2R_IMAGE:-emrgntcmplxty/r2r}
image: ${R2R_IMAGE:-ragtoriches/prod}
build:
context: .
args:
Expand Down
43 changes: 43 additions & 0 deletions py/sdk/README.md
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.

0 comments on commit cf78793

Please sign in to comment.