Xinference Rerank

Xinference Rerank는 Jina AI 호환 형식으로 후보 문서의 관련성 순위를 정합니다. 호출 시 현재 사용할 수 있는 Xinference Rerank 모델을 선택하며 나머지 요청 필드 및 응답 구조는 Jina Rerank와 같습니다. AGTCloud는 응답을 Jina AI 스타일로 통일하여 변환합니다.

Dify 등 클라이언트의 공급자 구성

Dify 등 Rerank 공급자 유형을 선택해야 하는 클라이언트에서는 Jina AI를 선택하고 현재 사용할 수 있는 Xinference Rerank 모델 ID를 입력합니다.

POST/v1/rerank

Jina AI 호환 형식으로 Xinference 재순위화 모델을 호출합니다. AGTCloud는 응답을 Jina AI 스타일로 통일하며 호출 방식, 요청 필드 및 응답 구조는 모두 Jina Rerank와 같습니다.

현재 API 키에 표시되는 Xinference Rerank 모델을 선택합니다. 쿼리는 명확하고 구체적이어야 하며 후보 문서는 의미가 완전하고 선택한 모델의 Token 상한을 초과하지 않아야 합니다. 문서가 많으면 배치 처리를 권장하며 top_n으로 반환 수를 제어합니다.

인증

bearerAuth

인증Bearer <token>

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

전달 위치: header

요청 본문

application/json

Xinference 문서 재순위화 요청 매개변수입니다.

TypeScript 타입 정의

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

model*string

현재 API 키에 표시되는 Xinference Rerank 모델 ID입니다.

길이1 <= length

query*string

후보 문서의 관련성 순위를 정할 쿼리 텍스트입니다. 명확하고 구체적인 표현을 권장하며 지나치게 광범위하거나 모호한 쿼리는 피합니다.

길이1 <= length

documents*array<string>

재순위화할 문서 목록입니다. 각 문서는 완전하고 의미가 명확해야 하며 선택한 모델의 최대 Token 제한을 초과하면 안 됩니다. 문서가 많으면 배치 처리를 권장합니다.

항목1 <= items

top_n?integer

관련성이 가장 높은 상위 N개 문서를 반환합니다. 생략하면 반환 수를 제한하지 않습니다. 적절히 설정하면 불필요한 결과 전송과 처리를 줄일 수 있습니다.

응답 본문

`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": [
    {
      "document": {
        "text": "워싱턴 D.C.(워싱턴 또는 D.C.라고도 하며 정식 명칭은 컬럼비아 특별구)는 미국의 수도입니다."
      },
      "index": 2,
      "relevance_score": 0.999071
    },
    {
      "document": {
        "text": "네바다주의 주도는 카슨시티입니다."
      },
      "index": 0,
      "relevance_score": 0.32713068
    },
    {
      "document": {
        "text": "북마리아나 제도는 태평양에 있는 섬들로, 수도는 사이판입니다."
      },
      "index": 1,
      "relevance_score": 0.1867867
    }
  ],
  "usage": {
    "prompt_tokens": 815,
    "completion_tokens": 0,
    "total_tokens": 815
  }
}

인증

요청 본문

응답 본문

200application/json

400

401

429

500

`application/json`