Spaces:
Build error
Build error
chore: rename url2text to reader
Browse files
README.md
CHANGED
|
@@ -4,13 +4,15 @@ Convert any URL to an LLM-friendly input with a simple prefix `https://r.jina.ai
|
|
| 4 |
|
| 5 |
## Usage
|
| 6 |
|
|
|
|
|
|
|
| 7 |
To use the Reader, simply prepend `https://r.jina.ai/` to any URL. For example, to convert the URL `https://en.wikipedia.org/wiki/Artificial_intelligence` to an LLM-friendly input, use the following URL:
|
| 8 |
|
| 9 |
```bash
|
| 10 |
https://r.jina.ai/https://en.wikipedia.org/wiki/Artificial_intelligence
|
| 11 |
```
|
| 12 |
|
| 13 |
-
### Streaming
|
| 14 |
|
| 15 |
Use accept-header to control the streaming behavior:
|
| 16 |
|
|
@@ -18,6 +20,12 @@ Use accept-header to control the streaming behavior:
|
|
| 18 |
curl -H "Accept: text/event-stream" https://r.jina.ai/https://en.m.wikipedia.org/wiki/Main_Page
|
| 19 |
```
|
| 20 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 21 |
|
| 22 |
## Install
|
| 23 |
|
|
@@ -32,3 +40,10 @@ git clone git@github.com:jina-ai/reader.git
|
|
| 32 |
cd backend/functions
|
| 33 |
npm install
|
| 34 |
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
## Usage
|
| 6 |
|
| 7 |
+
### Standard
|
| 8 |
+
|
| 9 |
To use the Reader, simply prepend `https://r.jina.ai/` to any URL. For example, to convert the URL `https://en.wikipedia.org/wiki/Artificial_intelligence` to an LLM-friendly input, use the following URL:
|
| 10 |
|
| 11 |
```bash
|
| 12 |
https://r.jina.ai/https://en.wikipedia.org/wiki/Artificial_intelligence
|
| 13 |
```
|
| 14 |
|
| 15 |
+
### Streaming mode
|
| 16 |
|
| 17 |
Use accept-header to control the streaming behavior:
|
| 18 |
|
|
|
|
| 20 |
curl -H "Accept: text/event-stream" https://r.jina.ai/https://en.m.wikipedia.org/wiki/Main_Page
|
| 21 |
```
|
| 22 |
|
| 23 |
+
### JSON mode
|
| 24 |
+
|
| 25 |
+
This is still very early and the result is not really a good JSON but three simple field `url`, `title` and `content`. You can use accept-header to control the output format:
|
| 26 |
+
```bash
|
| 27 |
+
curl -H "Accept: application/json" https://r.jina.ai/https://en.m.wikipedia.org/wiki/Main_Page
|
| 28 |
+
```
|
| 29 |
|
| 30 |
## Install
|
| 31 |
|
|
|
|
| 40 |
cd backend/functions
|
| 41 |
npm install
|
| 42 |
```
|
| 43 |
+
|
| 44 |
+
## About `[thinapps-shared](thinapps-shared)`
|
| 45 |
+
|
| 46 |
+
You might notice a reference to `thinapps-shared` submodule, an internal package we use to share code across our products. While it’s not yet open-sourced and isn't integral to the Reader's primary functions, it helps with logging, syntax enhancements, etc. Feel free to disregard it for now.
|
| 47 |
+
|
| 48 |
+
## License
|
| 49 |
+
Apache License 2.0
|