Rerank — Cohere

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

Headers

X-Client-NamestringOptional

The name of the project that is making the request.

Request

This endpoint expects an object.

modelstringRequired

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

querystringRequired

The search query

documentslist of stringsRequired

A list of texts that will be compared to the query. For optimal performance we recommend against sending more than 1,000 documents in a single request.

Note: long documents will automatically be truncated to the value of max_tokens_per_doc.

Note: structured data should be formatted as YAML strings for best performance.

top_nintegerOptional

Limits the number of returned rerank results to the specified value. If not passed, all the rerank results will be returned.

max_tokens_per_docintegerOptional

Defaults to 4096. Long documents will be automatically truncated to the specified number of tokens.

Response

resultslist of objects

An ordered list of ranked documents

idstringOptional

metaobjectOptional

1 import cohere 2 3 co = cohere.ClientV2() 4 5 docs = [ 6 "Carson City is the capital city of the American state of Nevada.", 7 "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.", 8 "Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.", 9 "Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.", 10 "Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.", 11 ] 12 13 response = co.rerank( 14 model="rerank-v3.5", 15 query="What is the capital of the United States?", 16 documents=docs, 17 top_n=3, 18 ) 19 print(response)

1 { 2 "results": [ 3 { 4 "index": 3, 5 "relevance_score": 0.999071 6 }, 7 { 8 "index": 4, 9 "relevance_score": 0.7867867 10 }, 11 { 12 "index": 0, 13 "relevance_score": 0.32713068 14 } 15 ], 16 "id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf", 17 "meta": { 18 "api_version": { 19 "version": "2", 20 "is_experimental": false 21 }, 22 "billed_units": { 23 "search_units": 1 24 } 25 } 26 }

1	import cohere
2
3	co = cohere.ClientV2()
4
5	docs = [
6	"Carson City is the capital city of the American state of Nevada.",
7	"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean. Its capital is Saipan.",
8	"Capitalization or capitalisation in English grammar is the use of a capital letter at the start of a word. English usage varies from capitalization in other languages.",
9	"Washington, D.C. (also known as simply Washington or D.C., and officially as the District of Columbia) is the capital of the United States. It is a federal district.",
10	"Capital punishment has existed in the United States since beforethe United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states.",
11	]
12
13	response = co.rerank(
14	model="rerank-v3.5",
15	query="What is the capital of the United States?",
16	documents=docs,
17	top_n=3,
18	)
19	print(response)

1	{
2	"results": [
3	{
4	"index": 3,
5	"relevance_score": 0.999071
6	},
7	{
8	"index": 4,
9	"relevance_score": 0.7867867
10	},
11	{
12	"index": 0,
13	"relevance_score": 0.32713068
14	}
15	],
16	"id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf",
17	"meta": {
18	"api_version": {
19	"version": "2",
20	"is_experimental": false
21	},
22	"billed_units": {
23	"search_units": 1
24	}
25	}
26	}