ドキュメントの再ランキング - MixRoute API

ドキュメントの再ランキング

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

ドキュメントの再ランキング

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

指定された文書をクエリとの関連度順に並べます。このエンドポイントは生成された回答ではなく、スコアと元の文書のインデックスを返します。

モデル

モデルID	説明
`rerank-v4.0-pro`	品質を重視したCohereの多言語関連度ランキングモデル。
`rerank-v4.0-fast`	低レイテンシを重視したCohereの多言語関連度ランキングモデル。

リクエストフィールド

フィールド	説明
`model`	必須: rerank-v4.0-fastまたはrerank-v4.0-pro。
`query`	必須のクエリ文字列。
`documents`	必須のドキュメント文字列の配列。
`top_n`	結果件数（任意）。ドキュメント数以下にしてください。

リクエスト例

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
}'

レスポンス

results[].indexとresults[].relevance_scoreを読み取ってください。インデックスは元の入力配列を参照します。documentオブジェクトが存在するとは限りません。スコアは順位付けの指標であり、較正済みの確率ではありません。

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"]])