Alli Retrieval API

Retrieval API를 사용하면 Alli에 업로드되어 있는 문서 중, 질문과 관련있는 페이지 정보 Top N개를 얻을 수 있습니다.

POST https://backend.alli.ai/webapi/retrieval

Parameters

Name
Type
Description

API-KEY

string

할당된 API 키입니다. 대시보드의 설정 메뉴 > 일반 탭에서 찾을 수 있습니다. 자세한 내용은 링크를 클릭해 주세요

Request Body

Name
Type
Description

question (required)*

string

질문

max_document_clues

integer

질문과 관련있는 페이지를 몇개 가져올지 결정합니다. default 값은 3개입니다.

bm25_score_weight (optional)

float

키워드 검색에 가중치입니다. 해당 값이 높을 수록 키워드 점수를 더 많이 반영합니다. 0~9의 값이 적당하며, 0은 키워드 검색을 사용하지 않는 것을 의미합니다. default 값은 9입니다.

text_vector_score_weight (optional)

float

문서 내용에 대한 시멘틱 검색 가중치입니다. 해당 값이 높을 수록 더 많이 반영됩니다. 마찬가지로, 0~9의 값이 적당하며, 0은 문서 내용에 대한 시멘틱 검색을 사용하지 않는 것을 의미합니다. default 값은 1입니다.

title_vector_score_weight (optional)

float

문서 제목에 대한 시멘틱 검색 가중치입니다. 마찬가지로, 0~9의 값이 적당하며, 0은 문서 제목에 대한 시멘틱 검색을 사용하지 않는 것을 의미합니다. default 값은 0입니다.

요청을 보내고 성공하면 JSON으로 결과를 얻을 수 있습니다.

ranking : 질문과 관련있는 페이지 순위

title : 질문과 관련있는 문서의 제목

text : 질문과 관련있는 문서의 페이지 내용

page_no : 페이지 넘버

비고

  • 키워드 검색 : 문장을 토큰으로 나누어 일치하는지로 점수를 부여

  • 시멘틱 검색 : 문장을 임베딩 벡터로 변환하여 유사도를 측정. 동의어에 대응 가능하다.

관련 검색에 대해서는 성공적인 RAG를 위한 리트리버 최적화 전략 올거나이즈 블로그에서 자세하게 설명하고 있습니다.

Response Example

이 때 REST API KEY를 프로젝트의 API 키로 바꾸어야 합니다. API 키는 대시보드의 설정 메뉴 아래 일반 탭에서 찾을 수 있습니다.

Response Example

Last updated

Was this helpful?