Method: projects.locations.rankingConfigs.rank

지정된 입력 쿼리를 기반으로 텍스트 레코드 목록의 순위를 지정합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
rankingConfig

string

필수 항목입니다. 순위 서비스 구성의 리소스 이름입니다(예: projects/{projectNum}/locations/{location}/rankingConfigs/default_ranking_config).

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

JSON 표현 
{
  "model": string,
  "topN": integer,
  "query": string,
  "records": [
    {
      object (RankingRecord)
    }
  ],
  "ignoreRecordDetailsInResponse": boolean,
  "userLabels": {
    string: string,
    ...
  }
}
필드
model

string

사용할 모델의 식별자입니다. 다음 중 하나입니다.

  • semantic-ranker-512@latest: 최대 입력 토큰 크기가 512인 시맨틱 순위 지정 모델입니다.

지정되지 않은 경우 기본적으로 semantic-ranker-512@latest로 설정됩니다.
topN

integer

반환할 결과 수입니다. 설정되지 않았거나 0보다 크지 않으면 모든 결과를 반환합니다.
query

string

사용할 쿼리입니다.
records[]

object (RankingRecord)

필수 항목입니다. 순위를 지정할 레코드 목록입니다.
ignoreRecordDetailsInResponse

boolean

true인 경우 응답에는 레코드 ID와 점수만 포함됩니다. 기본값은 false이며, 응답에 레코드 세부정보가 포함됩니다.
userLabels

map (key: string, value: string)

리소스에 적용된 사용자 라벨은 다음 요구사항을 충족해야 합니다.

  • 각 리소스는 여러 개의 라벨(최대 64개)을 가질 수 있습니다.
  • 각 라벨은 키-값 쌍이어야 합니다.
  • 키는 비워 둘 수 없으며 최소 길이는 1자이고 최대 길이는 63자입니다. 값은 비워 둘 수 있으며 최대 길이는 63자(영문 기준)입니다.
  • 키와 값에는 소문자, 숫자, 밑줄, 대시만 사용할 수 있습니다. 모든 문자는 UTF-8 인코딩을 사용해야 하며 국제 문자가 허용됩니다.
  • 라벨의 키 부분은 고유해야 합니다. 그러나 여러 리소스에 동일한 키를 사용할 수 있습니다.
  • 키는 소문자나 국제 문자로 시작해야 합니다.

자세한 내용은 Google Cloud 문서를 참고하세요.

응답 본문

RankService.Rank 메서드의 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "records": [
    {
      object (RankingRecord)
    }
  ]
}
필드
records[]

object (RankingRecord)

점수를 기준으로 내림차순으로 정렬된 레코드 목록입니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

rankingConfig 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.rankingConfigs.rank

자세한 내용은 IAM 문서를 참조하세요.

RankingRecord

RankService.Rank 메서드의 메시지를 녹음합니다.

JSON 표현 
{
  "id": string,
  "title": string,
  "content": string,
  "score": number
}
필드
id

string

레코드를 나타내는 고유 ID입니다.
title

string

레코드의 제목입니다. 기본적으로 비어 있습니다. title 또는 content 중 하나 이상을 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다.
content

string

레코드의 콘텐츠입니다. 기본적으로 비어 있습니다. title 또는 content 중 하나 이상을 설정해야 합니다. 그렇지 않으면 INVALID_ARGUMENT 오류가 발생합니다.
score

number

지정된 쿼리 및 선택된 모델을 기반으로 한 이 레코드의 점수입니다. 점수는 소수점 이하 2자리로 반올림됩니다. 점수가 0에 가까우면 설정되지 않은 값이 반환되지 않도록 0.0001로 반올림됩니다.