Rerank
Changed onScore documents against a query and return them reordered.
Results come back sorted by relevance_score, each carrying the index it held in the request so the caller can map them back.
Request
- Base URLhttps://api.jina.ai
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"documents": [
"Climate Change and Renewable Energy: A Global Perspective. Rising temperatures and extreme weather events are accelerating the transition to solar and wind power worldwide.",
"Le changement climatique et l'énergie renouvelable : une perspective européenne. L'Union européenne investit massivement dans les technologies vertes pour atteindre la neutralité carbone d'ici 2050.",
"Klimawandel und erneuerbare Energien: Deutsche Energiewende. Deutschland führt die Transformation des Energiesektors durch innovative Technologien und politische Maßnahmen an.",
"气候变化对可再生能源的影响:中国的绿色发展战略。中国正在大力推进太阳能和风能项目,以实现碳中和目标。",
"Artificial Intelligence in Healthcare: Revolutionizing Medical Diagnosis. AI-powered systems are improving accuracy in disease detection and treatment recommendations.",
"Blockchain Technology: Transforming Financial Services. Decentralized finance applications are reshaping traditional banking and payment systems."
],
"model": "jina-reranker-v2-base-multilingual",
"query": "Climate change impact on renewable energy adoption",
"return_documents": false,
"top_n": 4
}Response
Successful Response
Changes
- breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response400 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response401 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response403 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response404 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response409 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response429 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response500 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response503 - breaking
response property
codelist-of-types was widened by adding typesnullto media typeapplication/jsonof response504 - breaking
response property
errorslist-of-types was widened by adding typesnullto media typeapplication/jsonof response422 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response400 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response401 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response403 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response404 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response409 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response429 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response500 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response503 - breaking
response property
request_idlist-of-types was widened by adding typesnullto media typeapplication/jsonof response504 - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
added the optional property
to the response with the status - info
the response property
became required for the status
- breaking
- breaking
request property
/was restricted to a list of enum values - warning
removed the request property
/ - warning
removed the request property
/ - warning
removed the request property
/ - info
added
jina-reranker-v3.5mapping keys to the request discriminator - info
the
request property const valuejina-reranker-v3was removed - info
the
request property default value2048was removed - info
added the new
jina-reranker-v3enum value to the request property/ - info
added the new
jina-reranker-v3.5enum value to the request property/ - info
request property
/list-of-types was widened by adding typesnullto media typeapplication/json
- breaking