Method: projects.locations.rankingConfigs.rank

Ranks a list of text records based on the given input query.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{rankingConfig=projects/*/locations/*/rankingConfigs/*}:rank

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
rankingConfig

string

Required. The resource name of the rank service config, such as projects/{projectNum}/locations/{locationId}/rankingConfigs/default_ranking_config.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean
}
Fields
model

string

The identifier of the model to use. It is one of:

  • semantic-ranker-512@latest: Semantic ranking model with maxiumn input token size 512.

It is set to semantic-ranker-512@latest by default if unspecified.
topN

integer

The number of results to return. If this is unset or no bigger than zero, returns all results.
query

string

The query to use.
records[]

object (RankingRecord)

Required. A list of records to rank. At most 200 records to rank.
ignoreRecordDetailsInResponse

boolean

If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.

Response body

Response message for RankService.Rank method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
Fields
records[]

object (RankingRecord)

A list of records sorted by descending score.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

RankingRecord

Record message for RankService.Rank method.

JSON representation 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
Fields
id

string

The unique ID to represent the record.
title

string

The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
content

string

The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
score

number

The score of this record based on the given query and selected model.