Search Foundation Models

Score 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.

post/v1/rerank

Request

Request body

OR
OR

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

modelstring required

The model used for reranking.

objectstring

Object type, always list.

Changes

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property code list-of-types was widened by adding types null to media type application/json of response 504

    • breaking

      response property errors list-of-types was widened by adding types null to media type application/json of response 422

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 400

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 401

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 403

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 404

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 409

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 429

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 500

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 503

    • breaking

      response property request_id list-of-types was widened by adding types null to media type application/json of response 504

    • 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

      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.5 mapping keys to the request discriminator

    • info

      the request property const value jina-reranker-v3 was removed

    • info

      the request property default value 2048 was removed

    • info

      added the new jina-reranker-v3 enum value to the request property /

    • info

      added the new jina-reranker-v3.5 enum value to the request property /

    • info

      request property / list-of-types was widened by adding types null to media type application/json