GenAI Integration

Rerank documents (Vertex Rank)

Reranks records using Google Vertex AI's Ranking API. The request body follows the Vertex rankRecords schema.

post/genai/v1/rank

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/genai/v1/rank/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

modelstring

Vertex ranking model identifier.

querystring

topNinteger

ignoreRecordDetailsInResponseboolean

Response

Successful response

object required

Changes

No recorded changes to this operation across all 1 revision of this API.