Retrieval

Retrieval related APIs

Retrieval 검색 API

post

Retrieval API는 Alli에 업로드된 문서로부터 질문과 관련된 상위 N개의 페이지 정보를 얻을 수 있도록 합니다. 이 API는 키워드 검색과 Cognitive 검색 기능을 결합하여 유저 쿼리에 가장 관련성이 높은 문서 페이지를 제공합니다.

Authorizations

ApiKeyAuthTokenAuthProjectIdHeader

API-KEYstringRequired

Your API key for authentication

Header parameters

AGENT-EMAILstringOptional

Optional: Email of the agent to use for this request

USER-EMAILstringOptional

Optional: Email address to associate with the user

OWN-USER-IDstringOptional

Optional: User ID to identify or create a user

Body

application/json

questionstringOptional

문서 기반에서 검색할 질문

maxDocumentCluesintegerOptional

검색할 관련 페이지의 수를 결정합니다. 기본값은 3입니다.

bm25_score_weightnumber · floatOptional

키워드 검색을 위한 가중치입니다. 이 값이 높을수록 키워드 점수가 더 많이 반영됩니다. 값은 0-9 사이가 적절하며, 0의 값은 키워드 검색을 사용하지 않음을 의미합니다. 기본값은 9입니다.

text_vector_score_weightnumber · floatOptional

문서 콘텐츠의 의미 검색에 대한 가중치입니다. 이 값이 높을수록 더 많이 반영됩니다. 0-9 사이의 값이 적절하며, 0의 값은 문서 콘텐츠의 의미 검색이 사용되지 않음을 의미합니다. 기본 값은 1입니다.

title_vector_score_weightnumber · floatOptional

문서 제목에 대한 의미 검색의 가중치입니다. 마찬가지로, 0-9 사이의 값이 적절하며, 값이 0이면 문서 제목에 대한 의미 검색이 사용되지 않음을 의미합니다. 기본값은 0입니다.

hashtagsstring[]Optional

결과를 필터링하여 이 해시태그가 포함된 문서만 포함합니다.

hashtags_operatorstring · enumOptional

해시태그에 대한 논리 연산자(기본값은 "or")

Possible values:

exclude_hashtagsstring[]Optional

이 해시태그가 포함된 문서를 제외하도록 결과 필터링

exclude_hashtags_operatorstring · enumOptional

제외_해시태그에 대한 논리 연산자(기본값은 "or")

Possible values:

targetFoldersstring[]Optional

검색할 폴더 이름

folderIdsstring[]Optional

검색할 폴더의 ID

knowledgeBaseIdsstring[]Optional

검색할 특정 지식베이스의 ID

use_keywordsbooleanOptional

검색을 위해 키워드를 추출하고 사용할지 여부

use_clue_feedbackbooleanOptional

피드백 데이터를 사용하여 검색 결과를 개선할지 여부

Responses

200

결과를 성공적으로 검색했습니다.

application/json

400

유효하지 않은 매개변수

application/json

500

내부 서버 오류

application/json

post

/webapi/retrieval

HTTPcURLJavaScriptPython

POST /webapi/retrieval HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 348

{
  "question": "text",
  "maxDocumentClues": 1,
  "bm25_score_weight": 1,
  "text_vector_score_weight": 1,
  "title_vector_score_weight": 1,
  "hashtags": [
    "text"
  ],
  "hashtags_operator": "and",
  "exclude_hashtags": [
    "text"
  ],
  "exclude_hashtags_operator": "and",
  "targetFolders": [
    "text"
  ],
  "folderIds": [
    "text"
  ],
  "knowledgeBaseIds": [
    "text"
  ],
  "use_keywords": true,
  "use_clue_feedback": true
}

{
  "result": [
    {
      "ranking": 1,
      "title": "text",
      "text": "text",
      "pageNo": 1,
      "kb_id": "text"
    }
  ]
}