POST
/
v1
/
text
/
rerank
curl --request POST \
--url https://api.clovastudio.go.kr/v1/text/rerank \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"model": "bge-reranker-v2-m3",
"query": "한국의 수도는 어디인가요?",
"top_n": 2,
"return_documents": true,
"documents": [
"부산은 한국의 제2의 도시이며 중요한 항구 도시입니다.",
"서울은 대한민국의 수도이자 최대 도시입니다.",
"대구는 한국의 주요 도시 중 하나입니다.",
"인천은 서울과 인접한 중요한 항구 도시입니다."
]
}'
{
"status": {
"code": "20000",
"message": "OK"
},
"result": {
"model": "bge-reranker-v2-m3",
"documents": [
{
"index": 1,
"score": 0.98,
"document": "서울은 대한민국의 수도이자 최대 도시입니다."
},
{
"index": 3,
"score": 0.65,
"document": "인천은 서울과 인접한 중요한 항구 도시입니다."
}
]
},
"usage": {
"total_tokens": 45
}
}

Authorizations

Authorization
string
header
required

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

Body

application/json
query
string
required

질의 텍스트

Maximum length: 1000
documents
required

재순위할 문서 목록 (문자열 배열 또는 객체 배열). 최적의 성능을 위해 한 번에 100개 이하의 문서를 권장합니다. 긴 문서는 자동으로 잘릴 수 있습니다.

model
enum<string> | null
default:bge-reranker-v2-m3

사용할 reranker 모델 지원되는 재순위 모델

Available options:
rag42-rerank-v1,
bge-reranker-v2-m3
top_n
integer | null

반환할 결과 수 (기본값: 모든 문서 반환)

Required range: 1 <= x <= 100
return_documents
boolean | null
default:true

응답에 문서 내용 포함 여부

rank_fields
string[] | null

순위 재지정에 사용할 필드입니다. 현재 제공하는 모델은 순위 재지정 필드를 하나만 지원합니다.

Response

성공 - 재순위 결과 반환

status
object
required

응답 상태

result
object
required

재순위 결과

usage
object | null

API 사용량 정보 Rerank usage