Spaces:
Running
Running
rdmlx commited on
Commit ·
7817fe3
1
Parent(s): 82dad5b
Update documentation with live API URLs
Browse files- Replace placeholder URLs with actual Space URL
- Update total_embeddings count to 6407
- Add clickable link to interactive docs
- Mark API as live and publicly accessible
- API_DOCUMENTATION.md +16 -16
- README.md +3 -3
API_DOCUMENTATION.md
CHANGED
|
@@ -5,10 +5,10 @@ Complete documentation for integrating the Biblos Semantic Search API into your
|
|
| 5 |
## Base URL
|
| 6 |
|
| 7 |
```
|
| 8 |
-
https://
|
| 9 |
```
|
| 10 |
|
| 11 |
-
|
| 12 |
|
| 13 |
---
|
| 14 |
|
|
@@ -26,14 +26,14 @@ Returns API status and basic information.
|
|
| 26 |
"status": "online",
|
| 27 |
"model": "BAAI/bge-large-en-v1.5",
|
| 28 |
"books_loaded": 66,
|
| 29 |
-
"total_embeddings":
|
| 30 |
"device": "cpu"
|
| 31 |
}
|
| 32 |
```
|
| 33 |
|
| 34 |
**Example:**
|
| 35 |
```bash
|
| 36 |
-
curl https://
|
| 37 |
```
|
| 38 |
|
| 39 |
---
|
|
@@ -56,7 +56,7 @@ Returns detailed health status and list of available books.
|
|
| 56 |
|
| 57 |
**Example:**
|
| 58 |
```bash
|
| 59 |
-
curl https://
|
| 60 |
```
|
| 61 |
|
| 62 |
---
|
|
@@ -99,7 +99,7 @@ Perform semantic search over Bible text.
|
|
| 99 |
|
| 100 |
##### Basic Search
|
| 101 |
```bash
|
| 102 |
-
curl -X POST https://
|
| 103 |
-H "Content-Type: application/json" \
|
| 104 |
-d '{
|
| 105 |
"query": "faith without works is dead",
|
|
@@ -109,7 +109,7 @@ curl -X POST https://YOUR-SPACE-NAME.hf.space/search \
|
|
| 109 |
|
| 110 |
##### Search by Testament
|
| 111 |
```bash
|
| 112 |
-
curl -X POST https://
|
| 113 |
-H "Content-Type: application/json" \
|
| 114 |
-d '{
|
| 115 |
"query": "love your enemies",
|
|
@@ -120,7 +120,7 @@ curl -X POST https://YOUR-SPACE-NAME.hf.space/search \
|
|
| 120 |
|
| 121 |
##### Search Specific Books
|
| 122 |
```bash
|
| 123 |
-
curl -X POST https://
|
| 124 |
-H "Content-Type: application/json" \
|
| 125 |
-d '{
|
| 126 |
"query": "the beginning",
|
|
@@ -155,7 +155,7 @@ mat, mrk, luk, jhn, act, rom, 1co, 2co, gal, eph, php, col, 1th, 2th,
|
|
| 155 |
#### Basic Fetch
|
| 156 |
```javascript
|
| 157 |
async function searchBible(query, options = {}) {
|
| 158 |
-
const response = await fetch('https://
|
| 159 |
method: 'POST',
|
| 160 |
headers: {
|
| 161 |
'Content-Type': 'application/json',
|
|
@@ -212,7 +212,7 @@ export function useBibleSearch() {
|
|
| 212 |
setError(null)
|
| 213 |
|
| 214 |
try {
|
| 215 |
-
const response = await fetch('https://
|
| 216 |
method: 'POST',
|
| 217 |
headers: { 'Content-Type': 'application/json' },
|
| 218 |
body: JSON.stringify({ query, ...options })
|
|
@@ -273,7 +273,7 @@ def search_bible(query, books=None, testament=None, limit=10):
|
|
| 273 |
Returns:
|
| 274 |
List of search results
|
| 275 |
"""
|
| 276 |
-
url = 'https://
|
| 277 |
|
| 278 |
payload = {
|
| 279 |
'query': query,
|
|
@@ -311,7 +311,7 @@ import aiohttp
|
|
| 311 |
|
| 312 |
async def search_bible_async(query, **kwargs):
|
| 313 |
"""Async version of Bible search"""
|
| 314 |
-
url = 'https://
|
| 315 |
|
| 316 |
payload = {'query': query, **kwargs}
|
| 317 |
|
|
@@ -338,7 +338,7 @@ asyncio.run(main())
|
|
| 338 |
|
| 339 |
#### Basic Search
|
| 340 |
```bash
|
| 341 |
-
curl -X POST https://
|
| 342 |
-H "Content-Type: application/json" \
|
| 343 |
-d '{
|
| 344 |
"query": "blessed are the peacemakers"
|
|
@@ -347,7 +347,7 @@ curl -X POST https://YOUR-SPACE-NAME.hf.space/search \
|
|
| 347 |
|
| 348 |
#### Pretty Print with jq
|
| 349 |
```bash
|
| 350 |
-
curl -X POST https://
|
| 351 |
-H "Content-Type: application/json" \
|
| 352 |
-d '{
|
| 353 |
"query": "blessed are the peacemakers",
|
|
@@ -382,7 +382,7 @@ curl -X POST https://YOUR-SPACE-NAME.hf.space/search \
|
|
| 382 |
```javascript
|
| 383 |
async function safeSearch(query) {
|
| 384 |
try {
|
| 385 |
-
const response = await fetch('https://
|
| 386 |
method: 'POST',
|
| 387 |
headers: { 'Content-Type': 'application/json' },
|
| 388 |
body: JSON.stringify({ query })
|
|
@@ -433,7 +433,7 @@ Visit your Space URL at `/docs` for interactive Swagger UI documentation where y
|
|
| 433 |
- Try different parameter combinations
|
| 434 |
- View real-time responses
|
| 435 |
|
| 436 |
-
|
| 437 |
|
| 438 |
---
|
| 439 |
|
|
|
|
| 5 |
## Base URL
|
| 6 |
|
| 7 |
```
|
| 8 |
+
https://dssjon-biblos-api.hf.space
|
| 9 |
```
|
| 10 |
|
| 11 |
+
The API is live and publicly accessible at the URL above.
|
| 12 |
|
| 13 |
---
|
| 14 |
|
|
|
|
| 26 |
"status": "online",
|
| 27 |
"model": "BAAI/bge-large-en-v1.5",
|
| 28 |
"books_loaded": 66,
|
| 29 |
+
"total_embeddings": 6407,
|
| 30 |
"device": "cpu"
|
| 31 |
}
|
| 32 |
```
|
| 33 |
|
| 34 |
**Example:**
|
| 35 |
```bash
|
| 36 |
+
curl https://dssjon-biblos-api.hf.space/
|
| 37 |
```
|
| 38 |
|
| 39 |
---
|
|
|
|
| 56 |
|
| 57 |
**Example:**
|
| 58 |
```bash
|
| 59 |
+
curl https://dssjon-biblos-api.hf.space/health
|
| 60 |
```
|
| 61 |
|
| 62 |
---
|
|
|
|
| 99 |
|
| 100 |
##### Basic Search
|
| 101 |
```bash
|
| 102 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 103 |
-H "Content-Type: application/json" \
|
| 104 |
-d '{
|
| 105 |
"query": "faith without works is dead",
|
|
|
|
| 109 |
|
| 110 |
##### Search by Testament
|
| 111 |
```bash
|
| 112 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 113 |
-H "Content-Type: application/json" \
|
| 114 |
-d '{
|
| 115 |
"query": "love your enemies",
|
|
|
|
| 120 |
|
| 121 |
##### Search Specific Books
|
| 122 |
```bash
|
| 123 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 124 |
-H "Content-Type: application/json" \
|
| 125 |
-d '{
|
| 126 |
"query": "the beginning",
|
|
|
|
| 155 |
#### Basic Fetch
|
| 156 |
```javascript
|
| 157 |
async function searchBible(query, options = {}) {
|
| 158 |
+
const response = await fetch('https://dssjon-biblos-api.hf.space/search', {
|
| 159 |
method: 'POST',
|
| 160 |
headers: {
|
| 161 |
'Content-Type': 'application/json',
|
|
|
|
| 212 |
setError(null)
|
| 213 |
|
| 214 |
try {
|
| 215 |
+
const response = await fetch('https://dssjon-biblos-api.hf.space/search', {
|
| 216 |
method: 'POST',
|
| 217 |
headers: { 'Content-Type': 'application/json' },
|
| 218 |
body: JSON.stringify({ query, ...options })
|
|
|
|
| 273 |
Returns:
|
| 274 |
List of search results
|
| 275 |
"""
|
| 276 |
+
url = 'https://dssjon-biblos-api.hf.space/search'
|
| 277 |
|
| 278 |
payload = {
|
| 279 |
'query': query,
|
|
|
|
| 311 |
|
| 312 |
async def search_bible_async(query, **kwargs):
|
| 313 |
"""Async version of Bible search"""
|
| 314 |
+
url = 'https://dssjon-biblos-api.hf.space/search'
|
| 315 |
|
| 316 |
payload = {'query': query, **kwargs}
|
| 317 |
|
|
|
|
| 338 |
|
| 339 |
#### Basic Search
|
| 340 |
```bash
|
| 341 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 342 |
-H "Content-Type: application/json" \
|
| 343 |
-d '{
|
| 344 |
"query": "blessed are the peacemakers"
|
|
|
|
| 347 |
|
| 348 |
#### Pretty Print with jq
|
| 349 |
```bash
|
| 350 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 351 |
-H "Content-Type: application/json" \
|
| 352 |
-d '{
|
| 353 |
"query": "blessed are the peacemakers",
|
|
|
|
| 382 |
```javascript
|
| 383 |
async function safeSearch(query) {
|
| 384 |
try {
|
| 385 |
+
const response = await fetch('https://dssjon-biblos-api.hf.space/search', {
|
| 386 |
method: 'POST',
|
| 387 |
headers: { 'Content-Type': 'application/json' },
|
| 388 |
body: JSON.stringify({ query })
|
|
|
|
| 433 |
- Try different parameter combinations
|
| 434 |
- View real-time responses
|
| 435 |
|
| 436 |
+
**Live Interactive Docs:** [https://dssjon-biblos-api.hf.space/docs](https://dssjon-biblos-api.hf.space/docs)
|
| 437 |
|
| 438 |
---
|
| 439 |
|
README.md
CHANGED
|
@@ -70,7 +70,7 @@ Perform semantic search
|
|
| 70 |
|
| 71 |
### Using cURL
|
| 72 |
```bash
|
| 73 |
-
curl -X POST https://
|
| 74 |
-H "Content-Type: application/json" \
|
| 75 |
-d '{
|
| 76 |
"query": "faith and works",
|
|
@@ -81,7 +81,7 @@ curl -X POST https://YOUR-SPACE-URL/search \
|
|
| 81 |
|
| 82 |
### Using JavaScript
|
| 83 |
```javascript
|
| 84 |
-
const response = await fetch('https://
|
| 85 |
method: 'POST',
|
| 86 |
headers: { 'Content-Type': 'application/json' },
|
| 87 |
body: JSON.stringify({
|
|
@@ -100,7 +100,7 @@ console.log(data.results)
|
|
| 100 |
import requests
|
| 101 |
|
| 102 |
response = requests.post(
|
| 103 |
-
'https://
|
| 104 |
json={
|
| 105 |
'query': 'faith and works',
|
| 106 |
'testament': 'new',
|
|
|
|
| 70 |
|
| 71 |
### Using cURL
|
| 72 |
```bash
|
| 73 |
+
curl -X POST https://dssjon-biblos-api.hf.space/search \
|
| 74 |
-H "Content-Type: application/json" \
|
| 75 |
-d '{
|
| 76 |
"query": "faith and works",
|
|
|
|
| 81 |
|
| 82 |
### Using JavaScript
|
| 83 |
```javascript
|
| 84 |
+
const response = await fetch('https://dssjon-biblos-api.hf.space/search', {
|
| 85 |
method: 'POST',
|
| 86 |
headers: { 'Content-Type': 'application/json' },
|
| 87 |
body: JSON.stringify({
|
|
|
|
| 100 |
import requests
|
| 101 |
|
| 102 |
response = requests.post(
|
| 103 |
+
'https://dssjon-biblos-api.hf.space/search',
|
| 104 |
json={
|
| 105 |
'query': 'faith and works',
|
| 106 |
'testament': 'new',
|