Rerank

POST

Rerank sorts text inputs by semantic relevance to a specified query.

This endpoint expects an object.

modelstringRequired

The model to use for reranking.

querystringRequired

The query to rank against.

documentslist of stringsRequired

Array of documents to rank.

return_documentsbooleanOptionalDefaults to false

Boolean setting whether to return documents in output.

Successful response.

idstringOptional

Unique ID for the rerank response.

objectstringOptional

Type of object (list).

createdintegerOptional

Timestamp of when the rerank response was created.

modelstringOptional

The rerank model used.

resultslist of objectsOptional

The set of rankings.

1	curl -X POST https://api.predictionguard.com/rerank \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"model": "bge-reranker-v2-m3",
6	"query": "What is Deep Learning?",
7	"documents": [
8	"Deep Learning is pizza.",
9	"Deep Learning is not pizza."
10	],
11	"return_documents": true
12	}'

1	{
2	"id": "rerank-39bf1cf3-66cd-43d5-9185-b52baf742414",
3	"object": "list",
4	"created": 1732039610,
5	"model": "bge-reranker-v2-m3",
6	"results": [
7	{
8	"index": 0,
9	"relevance_score": 0.25128007,
10	"text": "Deep Learning is not pizza."
11	},
12	{
13	"index": 1,
14	"relevance_score": 0.5100618,
15	"text": "Deep Learning is not pizza."
16	}
17	]
18	}