Rerank Overview

1
import cohere
2
co = cohere.Client(api_key="<YOUR API KEY>")
3
4
query = "What is the capital of the United States?"
5
docs = [
6
    "Carson City is the capital city of the American state of Nevada. At the 2010 United States Census, Carson City had a population of 55,274.",
7
    "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean that are a political division controlled by the United States. Its capital is Saipan.",
8
    "Charlotte Amalie is the capital and largest city of the United States Virgin Islands. It has about 20,000 people. The city is on the island of Saint Thomas.",
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. The President of the USA and many major national government offices are in the territory. This makes it the political center of the United States of America.",
10
    "Capital punishment (the death penalty) has existed in the United States since before the United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states. The federal government (including the United States military) also uses capital punishment."]
11
results = co.rerank(model="rerank-english-v3.0", query=query, documents=docs, top_n=5, return_documents=True)

1
query = "What is the capital of the United States?"
2
docs = [
3
  {"Title":"Facts about Carson City","Content":"Carson City is the capital city of the American state of Nevada. At the 2010 United States Census, Carson City had a population of 55,274."},
4
  {"Title":"The Commonwealth of Northern Mariana Islands","Content":"The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean that are a political division controlled by the United States. Its capital is Saipan."},
5
  {"Title":"The Capital of United States Virgin Islands","Content":"Charlotte Amalie is the capital and largest city of the United States Virgin Islands. It has about 20,000 people. The city is on the island of Saint Thomas."},
6
  {"Title":"Washington D.C.","Content":"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. The President of the USA and many major national government offices are in the territory. This makes it the political center of the United States of America."},
7
	{"Title":"Capital Punishment in the US","Content":"Capital punishment (the death penalty) has existed in the United States since before the United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states. The federal government (including the United States military) also uses capital punishment."}]
8
results = co.rerank(model="rerank-english-v3.0", query=query, documents=docs, rank_fields=['Title','Content'],top_n=5, return_documents=True)

1
{
2
	"id": "75a94aa7-6761-4a64-a2ae-4bc0a62bc601",
3
	"results": [
4
		{
5
			"document": {
6
				"Content": "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. The President of the USA and many major national government offices are in the territory. This makes it the political center of the United States of America.",
7
				"Title": "Washington D.C."
8
			},
9
			"index": 3,
10
			"relevance_score": 0.9987405
11
		},
12
		{
13
			"document": {
14
				"Content": "Capital punishment (the death penalty) has existed in the United States since before the United States was a country. As of 2017, capital punishment is legal in 30 of the 50 states. The federal government (including the United States military) also uses capital punishment.",
15
				"Title": "Capital Punishment in the US"
16
			},
17
			"index": 4,
18
			"relevance_score": 0.5011778
19
		},
20
		{
21
			"document": {
22
				"Content": "Charlotte Amalie is the capital and largest city of the United States Virgin Islands. It has about 20,000 people. The city is on the island of Saint Thomas.",
23
				"Title": "The Capital of United States Virgin Islands"
24
			},
25
			"index": 2,
26
			"relevance_score": 0.10070161
27
		},
28
		{
29
			"document": {
30
				"Content": "The Commonwealth of the Northern Mariana Islands is a group of islands in the Pacific Ocean that are a political division controlled by the United States. Its capital is Saipan.",
31
				"Title": "The Commonwealth of Northern Mariana Islands"
32
			},
33
			"index": 1,
34
			"relevance_score": 0.03197956
35
		},
36
		{
37
			"document": {
38
				"Content": "Carson City is the capital city of the American state of Nevada. At the 2010 United States Census, Carson City had a population of 55,274.",
39
				"Title": "Facts about Carson City"
40
			},
41
			"index": 0,
42
			"relevance_score": 0.019456575
43
		}
44
	],
45
	"meta": {
46
		"api_version": {
47
			"version": "2022-12-06"
48
		},
49
		"billed_units": {
50
			"search_units": 1
51
		}
52
	}
53
}