문서 순위 변경

POST /rerank

API 키 인증

쿼리 와의 관련성에 따라 문서 목록의 순위를 재지정합니다.

이 엔드포인트는 쿼리 와 문서 목록을 수락한 다음 관련성 점수를 기준으로 내림차순으로 정렬된 문서를 반환합니다.

application/json

body 필수 사항

쿼리 문자열 필수 사항
검색 쿼리 문자열로 반환합니다.

최대 쿼리 길이:
- 8,000 rerank-2.5 및 rerank-2.5-lite에 대한 토큰
- 4,000 tokens for rerank-2
- 2,000 tokens for rerank-2-lite
최소 길이는 1입니다.
문서 array[string] 필수 사항
재지정할 문서 목록으로, 문자열로 제공됩니다.

제약 조건:
- 최대 문서 수: 1,000
- 쿼리 당 최대 토큰 + 문서 쌍:
  - rerank-2.5 및 rerank-2.5-lite에 대한 32,000
  - 16,000 for rerank-2
  - 8,000 for rerank-2-lite
- 최대 총 토큰(쿼리 토큰 × 문서 수 + 모든 문서 토큰의 합계):
  - rerank-2.5, rerank-2.5-lite, rerank-2 및 rerank-2-lite의 600K
최소 1 개, 1000 개 이하의 요소입니다. 각각의 최소 길이는 1입니다.
모델 문자열 필수 사항

사용할 재순위 모델입니다. 권장 모델: rerank-2.5, rerank-2.5-lite.

값은 rerank-2.5, rerank-2.5-lite, rerank-2 또는 rerank-2-lite입니다.
top_k 정수 | null

반환할 가장 관련성이 높은 문서의 수입니다. 지정하지 않으면 모든 문서가 순위 재지정 점수와 함께 반환됩니다.

최소값은 1입니다.
return_documents 부울
응답에 문서 텍스트를 포함할지 여부입니다.
- false (기본값): 각 문서 에 대해 {"index", "relevance_score"} 만 반환합니다.
- true: 각 문서 에 대해 {"index", "document", "relevance_score"} 반환
기본값은 false 입니다.
잘라내기 부울
컨텍스트 길이 제한을 초과하는 입력을 자를지 여부입니다.
- true (기본값): 컨텍스트 길이 제한에 맞게 쿼리 와 문서가 자동으로 잘립니다.
- false: 쿼리 또는 쿼리-문서 쌍이 컨텍스트 길이 제한을 초과하면 오류가 반환됩니다.
기본값은 true 입니다.

응답

200 application/json

Success
응답 속성 숨기기 응답 속성 표시 객체
- 객체 문자열 필수 사항
  
  객체 유형입니다. 항상 'list'를 반환합니다.
  
  값은 list입니다.
- 데이터 배열[객체] 필수 사항
  
  관련성 점수를 기준으로 내림차순으로 정렬된 결과 재지정 배열 입니다.
  
  데이터 속성 숨기기 데이터 속성 표시 객체
  
  index integer 필수 사항
  
  원본 입력 목록에 있는 문서 의 인덱스 .
  
  관련성 점수 숫자 필수 사항
  
  쿼리 와 관련된 문서 의 관련성 점수입니다.
  
  문서 문자열
  
  문서 텍스트입니다. return_documents 가 true로 설정하다 경우에만 포함됩니다.
- 모델 문자열 필수 사항
  
  순위 재지정에 사용되는 모델의 이름입니다.
- 사용법 객체 필수 사항
  
  사용량 속성 숨기기 사용량 속성 표시 객체
  
  total_tokens integer 필수 사항
  
  순위 재지정 작업을 위해 처리된 토큰의 총 개수입니다.
400 application/json

Invalid Request
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  요청 이 유효하지 않습니다. 이 오류는 잘못된 JSON, 잘못된 매개변수 유형, 잘못된 데이터 유형, 배치 크기가 너무 크거나, 총 토큰이 제한을 초과하거나, 예시 의 토큰이 컨텍스트 길이를 초과하기 때문에 발생할 수 있습니다.
401 application/json

승인되지 않음
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  잘못된 인증. 모델 API 키가 권한 부여 헤더에 Bearer VOYAGE_API_KEY(으)로 올바르게 지정되어 있는지 확인합니다.
403 application/json

Forbidden
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  액세스가 금지되어 있습니다. 요청 을 보내는 IP 주소 허용되지 않은 경우 이 문제가 발생할 수 있습니다.
429 application/json

속도 제한 초과
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  속도 제한을 초과했습니다. 요청 빈도 또는 토큰 사용량이 너무 높습니다. 요청 속도를 낮추거나 잠시 기다렸다가 다시 시도하세요.
500 application/json

내부 서버 오류
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  서버 에서 예기치 않은 오류가 발생했습니다. 잠시 기다린 후 요청 다시 시도하세요.
502 application/json

잘못된 게이트웨이
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  서버 업스트림 서버 로부터 잘못된 응답을 받았습니다. 잠시 기다린 후 요청 다시 시도하세요.
503 application/json

서비스를 사용할 수 없음
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  트래픽 증가 또는 유지 관리로 인해 서비스를 일시적으로 사용할 수 없습니다. 잠시 기다린 후 요청 다시 시도하세요.
504 application/json

게이트웨이 시간 초과
응답 속성 숨기기 응답 속성 표시 객체
- 세부 정보 문자열
  
  서버 업스트림 서버 로부터 시기적절한 응답을 받지 못했습니다. 잠시 기다린 후 요청 다시 시도하세요.

POST /rerank

curl \
 --request POST 'https://ai.mongodb.com/v1/rerank' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"query":"string","documents":["string"],"model":"rerank-2.5","top_k":42,"return_documents":false,"truncation":true}'

요청 예시

{
  "query": "string",
  "documents": [
    "string"
  ],
  "model": "rerank-2.5",
  "top_k": 42,
  "return_documents": false,
  "truncation": true
}

응답 예시(200)

{
  "object": "list",
  "data": [
    {
      "index": 42,
      "relevance_score": 42.0,
      "document": "string"
    }
  ],
  "model": "string",
  "usage": {
    "total_tokens": 42
  }
}

응답 예시(400)

{
  "detail": "string"
}

응답 예시(401)

{
  "detail": "string"
}

응답 예시(403)

{
  "detail": "string"
}

응답 예시(429)

{
  "detail": "string"
}

응답 예시(500)

{
  "detail": "string"
}

응답 예시(502)

{
  "detail": "string"
}

응답 예시(503)

{
  "detail": "string"
}

응답 예시(504)

{
  "detail": "string"
}