Alli Retrieval API

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

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

Parameters

NameTypeDescription

API-KEY

string

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

Request Body

NameTypeDescription

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 키는 대시보드의 설정 메뉴 아래 일반 탭에서 찾을 수 있습니다.

curl -X POST -d '{ 
  "question": "시중은행, 지방은행, 인터넷은행의 인가 요건 및 절차에 차이가 있는데 그 차이점은 무엇인가요?",
  "bm25_score_weight": 9
}' \
-H 'API-KEY: REST_API_KEY' \
-H 'Content-Type: application/json' \
https://backend.alli.ai/webapi/retrieval

Response Example

{
  "result": [
    {
      "ranking": 1, 
      "title": "[별첨] 지방은행의 시중은행 전환시 인가방식 및 절차.pdf", 
      "text": "2. 심사 내용\n가. 쟁점 사항 : 모든 세부심사요건 심사 vs 일부요건 심사\n지방은행의 경우 과거 은행업 인가를 받고 계속 영업중\nᄋ 지방은행과 시중은행에 요구되는 인가요건은 최저자본금 및 대주주\n요건 등 일부요건만 차이\n* 최저자본금: (시중銀) 1,000억원 (지방銀) 250억원 (인터넷銀) 250억원\n * 비금융주력자 주식보유한도: (시중銀) 4% (지방銀) 15% (인터넷銀) 34%\n지방은행을 시중은행으로 전환하는 인가내용 변경시 과거 심사받았던\n요건*에 대한 심사가 필요한지 여부\n* 사업계획 타당성 요건, 임원 요건, 인력·영업시설·전산설비 요건\n나. 검토·결론 : 신규인가에 준하여 모든 세부심사요건 심사\n지방은행의 시중은행으로 전환은 기존 인가내용의 “중요사항\n변경”에 해당\n기존 인가와 동일하게 법령상 모든 세부심사요건*을 심사\n* 대주주요건, 사업계획의 타당성 요건, 임원요건, 인력·영업시설·전산설비 요건 등\n※ (대법원 2011두21485) 이미 검정을 거친 내용을 실질적으로 변경하는 결과를\n가져오는 경우에는 새로운 검정절차를 취하는 것과 마찬가지라 할 수 있으므로\n검정절차상의 교과용도서심의회의 심의에 준하는 절차를 거쳐야 한다.\nᄋ 특히, 종전 대비 영업범위가 확대되는 점을 감안하여 사업계획,\n내부통제, 임원의 자격요건 등 경영 관련 세부심사요건 등은 \n보다 면밀히 심사\nᄋ 세부심사요건의 타당성 점검 위한 절차인 외부평가위원회*, 이해\n관계자 의견수렴 등 필요한 절차를 생략없이 모두 진행\n* (은행업감독규정 제7조) 감독원장은 인가심사와 관련하여 사업계획 등의 타당성을 \n평가하기 위하여 필요하다고 판단되는 경우에는 평가위원회를 구성·운영할 수 있다.", 
      "pageNo": 6
    }, 
    {
      "ranking": 2, 
      "title": "240130(보도자료) 지방은행의 시중은행 전환시 인가방식 및 절차.pdf", 
      "text": "보도시점\n2024.1.31.(수) 금융위 회의 후\n(별도공지)\n배포\n2024.1.30.(화) 10:00\n지방은행의 시중은행 전환시\n인가방식 및 절차\n은행법 제8조 은행업인가 규정에 따른 ‘인가내용의 변경’을 통해 전환\n 신규인가에 준하여 법령상 모든 세부심사요건 심사\n 예비인가 절차는 생략 가능하되, 신청인이 희망할 경우에는 진행\n정부는 2023년 7월 5일 은행권 경쟁촉진을 위해 지방은행의 시중은행 \n전환을 추진하겠다고 발표*한 바 있습니다.\n* 「은행권 경영·영업 관행·제도 개선 방안」\n현행 은행업 인가체계상 은행업 영위를 위해서는 시중은행·지방은행·인터넷\n전문은행 모두 은행법 제8조에 따라 금융위원회의 인가를 받아야 합니다. \n시중은행·지방은행·인터넷전문은행은 인가요건·절차가 대부분 동일하나, 일부 \n인가요건* 및 영업구역·방식에서 차이가 존재합니다.\n* 최소자본금: (시중銀) 1,000억원 (지방銀) 250억원 (인터넷銀) 250억원\n * 비금융주력자 주식보유한도: (시중銀) 4% (지방銀) 15% (인터넷銀) 34%\n<표> 영업구역 및 영업방식에 따른 은행의 종류 구분\n다만, 현행 은행법령상 지방은행의 시중은행 전환에 관한 명시적인 규정은 \n없으며, 종전에도 은행 종류의 전환 사례는 없었습니다.\n지방은행의 정관\n에서 특정지역으로 제한하고 있는 영업구역을 전국으로 변경시 시중은행\n으로 전환이 가능하다는 일부의견도 있으나, 은행 종류의 전환은 금융감독\n정책의 중요사항으로 사전 승인절차 없이 정관 변경만으로 허용하는 것은 \n부적절한 측면이 있습니다.\n- 1 -", 
      "keywords": "240130 (보도자료) 지방은행의 시중은행 전환시 인가방식 및 절차", 
      "pageNo": 1
    }, 
    {
      "ranking": 3, 
      "title": "[별첨] 지방은행의 시중은행 전환시 인가방식 및 절차.pdf", 
      "text": "참고 1 현행 은행업 인가체계\n은행업 영위를 위해서는 「은행법」(제8조)상 금융위 인가 필요\n* (은행법 §8➀) 은행업을 경영하려는 자는 금융위원회의 인가를 받아야 한다.\nᄋ 시중은행(전국영업)뿐만 아니라 지방은행 및 인터넷은행도 모두\n동일한 조항(제8조)에 따라 인가 받도록 규정\nᄋ 지방은행 및 인터넷은행은 시중은행과 인가요건·절차가 대부분 \n동일하나, 일부 인가요건* 및 영업구역·방식에서 차이 존재\n* 최저자본금: (시중銀) 1,000억원 (지방銀) 250억원 (인터넷銀) 250억원\n* 비금융주력자 주식보유한도: (시중銀) 4% (지방銀) 15% (인터넷銀) 34%\n<표1> 영업구역 및 영업방식에 따른 은행의 종류 구분\n영업방식 \\ 영업구역\n전 국\n일부 제한\n온 + 오프라인\n시중은행\n지방은행\n온라인\n인터넷전문은행\n-\n한편, 은행업 본인가를 받으려는 자는 예비인가 신청이 가능\n* (은행법 §11의2➀) 제8조에 따른 인가(본인가)를 받으려는 자는 미리 금융위원회에\n예비인가를 신청할 수 있다.\nᄋ 예비인가제도는 신청인의 본인가 가능성 등을 사전에 확인하여\n불필요한 투자를 방지하려는 취지\n* 통상 예비인가 단계에서 이해관계자 의견수렴, 사업계획 등의 타당성 점검 \n위한 외부평가위원회 운영 등 통해 본인가 단계 이전 상세히 심사\nᄋ 금융위는 예비인가에 조건(통상 인적·물적 시설을 갖추도록 하는 내용)을\n붙이고, 본인가시 해당 조건의 이행 여부 확인", 
      "keywords": "[별첨] 지방은행의 시중은행 전환시 인가방식 및 절차", 
      "pageNo": 4
    }
  ]
}

Last updated