curl --request POST \
--url 'https://api.elkapi.com/v1/rerank' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}'
import requests
url = "https://api.elkapi.com/v1/rerank"
headers = {
"Authorization": "Bearer <token>"
}
headers["Content-Type"] = "application/json"
payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
const url = "https://api.elkapi.com/v1/rerank";
const headers = {
"Authorization": "Bearer <token>"
};
headers["Content-Type"] = "application/json";
const payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
};
const response = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify(payload)
});
console.log(await response.json());
{
"id": "id",
"results": [
{
"index": 1,
"relevance_score": 1,
"document": {}
}
],
"meta": {}
}
Rerank Format
Document Reranking
- Rerank a list of documents by relevance to a query
POST
/
v1
/
rerank
curl --request POST \
--url 'https://api.elkapi.com/v1/rerank' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}'
import requests
url = "https://api.elkapi.com/v1/rerank"
headers = {
"Authorization": "Bearer <token>"
}
headers["Content-Type"] = "application/json"
payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
const url = "https://api.elkapi.com/v1/rerank";
const headers = {
"Authorization": "Bearer <token>"
};
headers["Content-Type"] = "application/json";
const payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
};
const response = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify(payload)
});
console.log(await response.json());
{
"id": "id",
"results": [
{
"index": 1,
"relevance_score": 1,
"document": {}
}
],
"meta": {}
}
curl --request POST \
--url 'https://api.elkapi.com/v1/rerank' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}'
import requests
url = "https://api.elkapi.com/v1/rerank"
headers = {
"Authorization": "Bearer <token>"
}
headers["Content-Type"] = "application/json"
payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
}
response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())
const url = "https://api.elkapi.com/v1/rerank";
const headers = {
"Authorization": "Bearer <token>"
};
headers["Content-Type"] = "application/json";
const payload = {
"model": "jina-reranker-v2-base-multilingual",
"query": "query",
"documents": [
"document"
]
};
const response = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify(payload)
});
console.log(await response.json());
{
"id": "id",
"results": [
{
"index": 1,
"relevance_score": 1,
"document": {}
}
],
"meta": {}
}
Authorizations
string
required
All endpoints require Bearer Token authentication.Add it to the request headers:
Authorization: Bearer YOUR_API_KEY
Body
string
default:"jina-reranker-v2-base-multilingual"
required
Example:
jina-reranker-v2-base-multilingualstring
required
Query text
array<string or object>
required
List of documents to rerank
integer
Return the top N results
boolean
default:"false"
Response
string
object
⌘I