Back to Home

Reranker by Contextual AI

Name: Reranker by Contextual AI
Brand: Reranker by Contextual AI
Rating: 5 (102 reviews)

The world's first instruction-following reranker

Visit Website

102 Upvotes

About

This page provides the API reference for Contextual AI's Rerank endpoint. It details the POST /rerank method, allowing users to rank a list of documents based on a query and custom instructions. The documentation includes cURL examples for making requests, specifies required parameters like 'query', 'documents', and 'model', and outlines optional parameters such as 'top_n', 'instruction', and 'metadata'. It also describes the expected JSON response format, token limits, and highlights features like multilinguality and instruction following capabilities. The page is part of a larger API documentation suite, offering navigation to other endpoints like datastores, agents, and billing.

Categories & Tags

API Developer Tools Artificial Intelligence #Minimal #Clean #Documentation #API Reference #Functional

Color Palette

Background White

#FFFFFF

80%

Text Dark Grey

#333333

15%

Accent Blue

#007bff

Typography

Sans-serif

Body text, Headings, Navigation

Monospace

Code examples (cURL, JSON)

Design Review

The design of the Contextual AI Rerank API documentation is highly functional and adheres to best practices for developer-focused content. The layout is clean and intuitive, featuring a clear left-hand navigation panel for easy access to different API sections. The use of a light theme with dark, readable text ensures excellent contrast and legibility. Code examples are prominently displayed and well-formatted, making it easy for developers to understand and implement the API. The overall aesthetic is professional and straightforward, prioritizing clarity and usability over elaborate visual elements, which is ideal for technical documentation. The design effectively supports the primary goal of providing clear and concise API information.