Cohere Rerank

Cohere 스타일의 Rerank 요청 구조로 후보 문서를 재순위화합니다.

Cohere Rerank 인터페이스는 쿼리 텍스트를 기준으로 후보 문서의 관련성 순위를 정합니다. 핵심 요청 필드는 Jina Rerank와 대체로 같으며 X-Client-Name과 max_tokens_per_doc을 추가로 지원합니다. 응답에는 문서의 원본 인덱스, 관련성 점수, 요청 식별자, API 버전 및 과금 메타데이터가 포함됩니다.

POST/v1/rerank

쿼리 텍스트를 기준으로 후보 문서의 관련성 점수를 계산하고 관련성이 높은 순으로 정렬된 결과를 반환합니다. 핵심 요청 필드는 Jina Rerank와 대체로 같으며 X-Client-Name과 max_tokens_per_doc을 추가로 지원합니다. 성공 응답에는 결과 인덱스, 관련성 점수, 요청 식별자, API 버전 및 과금 메타데이터가 포함됩니다.

더 안정적인 순위를 얻으려면 쿼리를 명확하고 구체적으로 작성하고 문서를 간결하면서 의미가 완전하도록 유지합니다. 긴 문서는 max_tokens_per_doc에 따라 잘립니다. 요청당 문서 수는 1,000개 이하를 권장하며 구조화된 데이터는 YAML 문자열로 변환하는 것을 권장합니다.

인증

bearerAuth

인증Bearer <token>

Authorization Header에 Bearer your-api-key를 사용합니다.

전달 위치: header

Header 매개변수

X-Client-Name?string

요청을 보내는 프로젝트 이름입니다.

요청 본문

application/json

Cohere 스타일의 문서 재순위화 요청 매개변수입니다.

TypeScript 타입 정의

TypeScript에서 request body 타입을 사용하세요.

model*string

사용할 재순위화 모델 ID입니다. 현재 API 키에 표시되며 Cohere Rerank 형식을 지원하는 모델을 입력합니다.

길이1 <= length

query*string

후보 문서와 비교할 쿼리 텍스트입니다. 명확하고 구체적인 쿼리를 권장하며 지나치게 모호하거나 광범위한 표현은 피합니다.

길이1 <= length

documents*array<string>

쿼리와 비교할 텍스트 목록입니다. 요청당 문서 수는 1,000개 이하를 권장합니다. 긴 문서는 max_tokens_per_doc에 따라 잘리며 구조화된 데이터는 YAML 문자열로 변환하는 것을 권장합니다.

항목1 <= items

top_n?integer

반환할 재순위화 결과 수를 제한합니다. 생략하면 모든 결과를 반환합니다. 소수의 결과만 필요할 때 이 필드로 후속 처리를 줄일 수 있습니다.

max_tokens_per_doc?integer

재순위화에 사용할 문서별 최대 Token 수이며, 이를 초과하는 내용은 잘립니다.

기본값4096

응답 본문

`application/json`

curl -X POST "https://example.com/v1/rerank" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_ID",
    "query": "미국의 수도는 어디인가요?",
    "documents": [
      "네바다주의 주도는 카슨시티입니다.",
      "북마리아나 제도는 태평양에 있는 섬들로, 수도는 사이판입니다.",
      "워싱턴 D.C.(워싱턴 또는 D.C.라고도 하며 정식 명칭은 컬럼비아 특별구)는 미국의 수도입니다.",
      "영어 문법에서 대문자 표기는 단어의 첫 글자에 대문자를 사용하는 것입니다. 영어의 대문자 사용법은 다른 언어와 다릅니다.",
      "미국에서는 국가가 성립되기 전부터 사형이 존재했습니다. 2017년 기준으로 50개 주 중 30개 주에서 사형이 합법이었습니다."
    ],
    "top_n": 3
  }'

{
  "results": [
    {
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "id": "07734bd2-2473-4f07-94e1-0d9f0e6843cf",
  "meta": {
    "api_version": {
      "version": "2",
      "is_experimental": false
    },
    "billed_units": {
      "search_units": 1
    }
  }
}

인증

Header 매개변수

요청 본문

응답 본문

200application/json

400

401

403

404

422

429

500

503

`application/json`