Rerank | Prediction Guard

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

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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_documentsbooleanOptional

Boolean setting whether to return documents in output.

Successful response.

idstring

Unique ID for the rerank response.

objectstring

Type of object (list).

createdinteger

Timestamp of when the rerank response was created.

modelstring

The rerank model used.

resultslist of objects

The set of rankings.

400

Bad Request Error

403

Forbidden Error

$	curl -X POST https://{your-pg.api-domain}.com/rerank \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"model": "bge-reranker-v2-m3",
>	"query": "What is Deep Learning?",
>	"documents": [
>	"Deep Learning is pizza.",
>	"Deep Learning is not pizza."
>	],
>	"return_documents": true
>	}'

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	}

$	curl -X POST https://{your-pg.api-domain}.com/rerank \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"model": "bge-reranker-v2-m3",
>	"query": "What is Deep Learning?",
>	"documents": [
>	"Deep Learning is pizza.",
>	"Deep Learning is not pizza."
>	],
>	"return_documents": true
>	}'

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	}