Rerank API (v1)

POST/v1/rerankRerank API (v1)

This endpoint takes in a query and a list of texts and produces an ordered array with each text assigned a relevance score.

Parameters

X-Client-Namestringheader

The name of the project that is making the request.

Request body

application/json

object

documentsarray of valuerequired

A list of document objects or strings to rerank. If a document is provided the text fields is required and all other fields will be preserved in the response. The total max chunks (length of documents * max_chunks_per_doc) must be less than 10000. We recommend a maximum of 1,000 documents for optimal endpoint performance.

Show child attributes

Show array items

oneOf · 2 options

Option 1string

Option 2objectRerankDocument

textstringrequired

The text of the document to rerank.

max_chunks_per_docinteger

The maximum number of chunks to produce internally from a document

default 10

modelstring

The identifier of the model to use, eg `rerank-v3.5`.

querystringrequired

The search query

rank_fieldsarray of string

If a JSON object is provided, you can specify which keys you would like to have considered for reranking. The model will rerank based on order of the fields passed in (i.e. rank_fields=['title','author','text'] will rerank using the values in title, author, text sequentially. If the length of title, author, and text exceeds the context length of the model, the chunking will not re-consider earlier fields). If not provided, the model will use the default text field for ranking.

Show child attributes

return_documentsboolean

- If false, returns results without the doc text - the api will return a list of {index, relevance score} where index is inferred from the list passed into the request. - If true, returns results with the doc text passed in - the api will return an ordered list of {index, text, relevance score} where index + text refers to the list passed into the request.

default false

top_ninteger

The number of most relevant documents or indices to return, defaults to the length of the documents

minimum 1

Example request

{
  "documents": [
    {
      "text": "string"
    }
  ],
  "max_chunks_per_doc": 10,
  "model": "string",
  "query": "string",
  "rank_fields": [
    "string"
  ],
  "return_documents": false,
  "top_n": 0
}

Responses

object

idstring

metaobject

Show child attributes

api_versionobject

Show child attributes

is_deprecatedboolean

is_experimentalboolean

versionstringrequired

billed_unitsobject

Show child attributes

classificationsnumber

The number of billed classifications units.

image_tokensnumber

The number of billed image tokens.

imagesnumber

The number of billed images.

input_tokensnumber

The number of billed input tokens.

output_tokensnumber

The number of billed output tokens.

pagesnumber

The number of billed pages parsed.

search_unitsnumber

The number of billed search units.

cached_tokensnumber

The number of prompt tokens that hit the inference cache.

tokensobject

Show child attributes

input_tokensnumber

The number of tokens used as input to the model.

output_tokensnumber

The number of tokens produced by the model.

warningsarray of string

Show child attributes

resultsarray of objectrequired

An ordered list of ranked documents

Show child attributes

Show array items

documentobject

If `return_documents` is set as `false` this will return none, if `true` it will return the documents passed in

Show child attributes

textstringrequired

The text of the document to rerank

indexintegerrequired

Corresponds to the index in the original list of documents to which the ranked document belongs. (i.e. if the first value in the `results` object has an `index` value of 3, it means in the list of documents passed in, the document at `index=3` had the highest relevance)

relevance_scorenumber · floatrequired

Relevance scores are normalized to be in the range `[0, 1]`. Scores close to `1` indicate a high relevance to the query, and scores closer to `0` indicate low relevance. It is not accurate to assume a score of 0.9 means the document is 2x more relevant than a document with a score of 0.45

Example response

{
  "id": "string",
  "meta": {
    "api_version": {
      "is_deprecated": true,
      "is_experimental": true,
      "version": "string"
    },
    "billed_units": {
      "classifications": 0,
      "image_tokens": 0,
      "images": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "pages": 0,
      "search_units": 0
    },
    "cached_tokens": 0,
    "tokens": {
      "input_tokens": 0,
      "output_tokens": 0
    },
    "warnings": [
      "string"
    ]
  },
  "results": [
    {
      "document": {
        "text": "string"
      },
      "index": 0,
      "relevance_score": 0
    }
  ]
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

object

idstring

messagestring

Example response

{
  "id": "string",
  "message": "string"
}

Examples

X-Client-Nameheader parameter

curl -X POST 'https://api.cohere.com/v1/rerank' \
  -H 'Content-Type: application/json' \
  -d '{"documents":[{"text":"string"}],"max_chunks_per_doc":10,"model":"string","query":"string","rank_fields":["string"],"return_documents":false,"top_n":0}'

const response = await fetch('https://api.cohere.com/v1/rerank', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({"documents":[{"text":"string"}],"max_chunks_per_doc":10,"model":"string","query":"string","rank_fields":["string"],"return_documents":false,"top_n":0}),
});
const data = await response.json();

const response = await fetch('https://api.cohere.com/v1/rerank', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: "{\"documents\":[{\"text\":\"string\"}],\"max_chunks_per_doc\":10,\"model\":\"string\",\"query\":\"string\",\"rank_fields\":[\"string\"],\"return_documents\":false,\"top_n\":0}" });
console.log(await response.json());

import requests

response = requests.request(
    "POST",
    "https://api.cohere.com/v1/rerank",
    headers={"Content-Type": "application/json"},
    data='{"documents":[{"text":"string"}],"max_chunks_per_doc":10,"model":"string","query":"string","rank_fields":["string"],"return_documents":false,"top_n":0}',
)
print(response.json())

package main

import (
	"context"
	"net/http"
	"strings"
)

func main() {
	ctx := context.Background()
	body := strings.NewReader(`{"documents":[{"text":"string"}],"max_chunks_per_doc":10,"model":"string","query":"string","rank_fields":["string"],"return_documents":false,"top_n":0}`)
	req, err := http.NewRequestWithContext(ctx, "POST", "https://api.cohere.com/v1/rerank", body)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.cohere.com/v1/rerank");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($request, CURLOPT_POSTFIELDS, "{\"documents\":[{\"text\":\"string\"}],\"max_chunks_per_doc\":10,\"model\":\"string\",\"query\":\"string\",\"rank_fields\":[\"string\"],\"return_documents\":false,\"top_n\":0}");
curl_setopt($request, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.cohere.com/v1/rerank"))
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"documents\":[{\"text\":\"string\"}],\"max_chunks_per_doc\":10,\"model\":\"string\",\"query\":\"string\",\"rank_fields\":[\"string\"],\"return_documents\":false,\"top_n\":0}"))
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.cohere.com/v1/rerank")
request = Net::HTTPGenericRequest.new("POST", true, true, uri)
request['Content-Type'] = 'application/json'
request.body = "{\"documents\":[{\"text\":\"string\"}],\"max_chunks_per_doc\":10,\"model\":\"string\",\"query\":\"string\",\"rank_fields\":[\"string\"],\"return_documents\":false,\"top_n\":0}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://api.cohere.com/v1/rerank");
request.Content = new StringContent("{\"documents\":[{\"text\":\"string\"}],\"max_chunks_per_doc\":10,\"model\":\"string\",\"query\":\"string\",\"rank_fields\":[\"string\"],\"return_documents\":false,\"top_n\":0}", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);

{
  "id": "string",
  "meta": {
    "api_version": {
      "is_deprecated": true,
      "is_experimental": true,
      "version": "string"
    },
    "billed_units": {
      "classifications": 0,
      "image_tokens": 0,
      "images": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "pages": 0,
      "search_units": 0
    },
    "cached_tokens": 0,
    "tokens": {
      "input_tokens": 0,
      "output_tokens": 0
    },
    "warnings": [
      "string"
    ]
  },
  "results": [
    {
      "document": {
        "text": "string"
      },
      "index": 0,
      "relevance_score": 0
    }
  ]
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

{
  "id": "string",
  "message": "string"
}

Search documentation

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations

Rerank API (v1)

Parameters

Request body

Responses

/datasets

/connectors

/embed-jobs

/finetuning

/models

/audio/transcriptions

/batches

Operations