DeepFellow API ReferenceRerank
Create Rerank
Rerank given documents.
Authorization[Bearer <token>]
In: header
Header Parameters
OpenAI-Organization?[Openai-Organization]
Organization Id from OpenAi compatible endpoint. Required to organization access or project access (with OpenAI-Project header) when logged as User or Admin User.
OpenAI-Project?[Openai-Project]
Project Id from OpenAi compatible endpoint. Required to project access for organization api key or User / Admin User access with OpenAI-Organization
model[Model]
query[Query]
documents[Documents]
top_n?[Top N]
return_documents?[Return Documents]
rank_fields?[Rank Fields]
max_chunks_per_doc?[Max Chunks Per Doc]
Response Body
curl -X POST "https://deepfellow-server-host/v1/rerank" \ -H "OpenAI-Organization: string" \ -H "OpenAI-Project: string" \ -H "Content-Type: application/json" \ -d '{ "model": "string", "query": "string", "documents": [ "string" ] }'{
"id": "string",
"results": [
{
"index": 0,
"relevance_score": 0,
"document": {}
}
],
"meta": {}
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}We use cookies on our website. We use them to ensure proper functioning of the site and, if you agree, for purposes such as analytics, marketing, and targeting ads.