Document Reranking - MixRoute API

Document Reranking

curl --request POST \
  --url https://api.mixroute.ai/v1/rerank

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixroute.ai/v1/rerank",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixroute.ai/v1/rerank"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixroute.ai/v1/rerank")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Document Reranking

curl --request POST \
  --url https://api.mixroute.ai/v1/rerank

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mixroute.ai/v1/rerank",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mixroute.ai/v1/rerank"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.mixroute.ai/v1/rerank")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Rank supplied documents by relevance to a query. This endpoint returns scores and original document indexes, not generated answers.

Models

Model ID	Description
`rerank-v4.0-pro`	Cohere quality-focused multilingual relevance ranking model.
`rerank-v4.0-fast`	Cohere latency-focused multilingual relevance ranking model.

Request Fields

Field	Description
`model`	Required: rerank-v4.0-fast or rerank-v4.0-pro.
`query`	Required query string.
`documents`	Required array of document strings.
`top_n`	Optional result count; keep within the number of documents.

Request Example

curl --request POST "https://api.mixroute.ai/v1/rerank" \
  --header "Authorization: Bearer $MIXROUTE_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "model": "rerank-v4.0-pro",
  "query": "API documentation",
  "documents": [
    "An API reference for developers.",
    "A recipe for soup."
  ],
  "top_n": 1
}'

Response

Read results[].index and results[].relevance_score. The index refers to the original input array; do not assume a document object is present. Scores are ranking signals, not calibrated probabilities.

import os
import requests

documents = ["An API reference for developers.", "A recipe for soup."]
response = requests.post(
    "https://api.mixroute.ai/v1/rerank",
    headers={"Authorization": "Bearer " + os.environ["MIXROUTE_API_KEY"]},
    json={"model": "rerank-v4.0-pro", "query": "API documentation",
          "documents": documents, "top_n": 1},
    timeout=60,
)
response.raise_for_status()
for item in response.json()["results"]:
    print(item["relevance_score"], documents[item["index"]])