RAG

Knowledge base node related APIs

하이라이트 받기

get

/webapi/v2/highlights/{clue_id}

Retrieve bounding box coordinates for answer highlights in a knowledge base document page.

Authorizations

API-KEYstringRequired

Your API key for authentication

Path parameters

clue_idstringRequired

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

Responses

200

확인

application/json

typestring · enumRequired

다양한 유형의 답변을 표현하기 위해 정의된 열거형

Possible values:

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/highlights/{clue_id}

GET /webapi/v2/highlights/{clue_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "bboxes": [
    {
      "left": 1,
      "top": 1,
      "right": 1,
      "bottom": 1
    }
  ],
  "type": "PARAGRAPH"
}

Highlight Retrieval Result

post

/webapi/v2/retrieval/highlight

Return highlight bboxes for a single Retrieval result resolved straight from the retrieved page chunk (kbId + pageNo + subTextIndex), without a generative-answer clue id.

Authorizations

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

kbIdstring · min: 1Required

pageNointeger · min: 1Required

subTextIndexintegerOptionalDefault: 1

passageTextstring · nullableOptional

Responses

200

application/json

typestring · enumRequired

다양한 유형의 답변을 표현하기 위해 정의된 열거형

Possible values:

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/retrieval/highlight

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

{
  "kbId": "text",
  "pageNo": 1,
  "subTextIndex": 1,
  "passageText": "text"
}

{
  "bboxes": [
    {
      "left": 1,
      "top": 1,
      "right": 1,
      "bottom": 1
    }
  ],
  "type": "PARAGRAPH"
}

RARE 상태

get

/webapi/v2/rare/status

프로젝트의 RARE 빌드/생성 상태를 조회합니다.

Authorizations

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

Responses

200

application/json

build_statusstringRequired

job_statusstringRequired

job_typestringRequired

build_run_idstring · nullableOptional

error_messagestring · nullableOptional

folder_idsstring[] · nullableOptional

default_modelstringOptionalDefault: ""

generation_modelstringOptionalDefault: ""

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/status

GET /webapi/v2/rare/status HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "build_status": "text",
  "job_status": "text",
  "job_type": "text",
  "build_run_id": "text",
  "error_message": "text",
  "build_progress": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "generate_progress": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "build_stats": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "generate_stats": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "folder_ids": [
    "text"
  ],
  "default_model": "",
  "generation_model": ""
}

RARE 빌드

post

/webapi/v2/rare/build

RARE 빌드 작업을 시작합니다.

Authorizations

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

languagestringOptionalDefault: Korean

default_modelstringOptionalDefault: gpt54_nano

similarity_thresholdnumberOptionalDefault: 0.5

top_k_per_chunkintegerOptionalDefault: 1

max_similar_itemsintegerOptionalDefault: 256

max_workersintegerOptionalDefault: 100

folder_idsstring[] · nullableOptional

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/build

POST /webapi/v2/rare/build HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 161

{
  "language": "Korean",
  "default_model": "gpt54_nano",
  "similarity_threshold": 0.5,
  "top_k_per_chunk": 1,
  "max_similar_items": 256,
  "max_workers": 100,
  "folder_ids": [
    "text"
  ]
}

{
  "message": "text",
  "task_id": "text"
}

RARE 생성

post

/webapi/v2/rare/generate

RARE 생성 작업을 시작합니다. 빌드가 먼저 완료되어 있어야 합니다.

Authorizations

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

num_samplesintegerOptionalDefault: 10

input_pool_sizeintegerOptionalDefault: 50

num_questionsintegerOptionalDefault: 10

num_informationintegerOptionalDefault: 2

languagestringOptionalDefault: Korean

default_modelstringOptionalDefault: gpt54_nano

generation_modelstringOptionalDefault: gpt54

rare_user_promptstringOptionalDefault: ""

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/generate

POST /webapi/v2/rare/generate HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "num_samples": 10,
  "input_pool_size": 50,
  "num_questions": 10,
  "num_information": 2,
  "language": "Korean",
  "default_model": "gpt54_nano",
  "generation_model": "gpt54",
  "rare_user_prompt": ""
}

{
  "message": "text",
  "task_id": "text"
}

RARE 취소

post

/webapi/v2/rare/cancel

실행 중인 RARE 작업에 협력적 취소를 요청합니다.

Authorizations

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

Responses

200

application/json

messagestringRequired

task_idstringRequired

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/rare/cancel

POST /webapi/v2/rare/cancel HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "message": "text",
  "task_id": "text"
}

RARE 결과 목록

get

/webapi/v2/rare/results

프로젝트의 최근 RARE 생성 결과를 조회합니다.

Authorizations

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

Responses

200

application/json

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/results

GET /webapi/v2/rare/results HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

{
  "results": [
    {
      "id": "text",
      "created_at": "text",
      "n_samples": 1,
      "rare_config": "text",
      "result_file_url": "text"
    }
  ]
}

RARE 결과 삭제

delete

/webapi/v2/rare/results/{result_id}

ID로 RARE 생성 결과를 삭제합니다.

Authorizations

API-KEYstringRequired

Your API key for authentication

Path parameters

result_idstringRequired

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

delete/webapi/v2/rare/results/{result_id}

DELETE /webapi/v2/rare/results/{result_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

RARE CSV

get

/webapi/v2/rare/csv

스토리지의 RARE CSV 파일을 프록시합니다. 헤더와 행을 포함한 JSON을 반환합니다.

Authorizations

API-KEYstringRequired

Your API key for authentication

Query parameters

pathstringOptionalDefault: ""

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/rare/csv

GET /webapi/v2/rare/csv HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

대량 처리 실행

post

/webapi/v2/bulk_processing/run

대량 처리(GA 또는 RAG)를 시작합니다.

인자: file: question, model, search_type 컬럼을 포함하는 CSV 파일. 선택 항목: target_answer, target_clue, hashtag, folder. bulk_type: "ga"(기본값) 또는 "rag"

Authorizations

API-KEYstringRequired

Your API key for authentication

Query parameters

bulk_typestring · enumOptionalDefault: gaPossible values:

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

filestring · binaryRequired

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

post/webapi/v2/bulk_processing/run

POST /webapi/v2/bulk_processing/run HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content

결과 목록

get

/webapi/v2/bulk_processing/results

대량 처리 결과 목록을 조회합니다(GA + RAG 통합, 페이지네이션).

Authorizations

API-KEYstringRequired

Your API key for authentication

Query parameters

pageintegerOptionalDefault: 1

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/bulk_processing/results

GET /webapi/v2/bulk_processing/results HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

결과 다운로드

get

/webapi/v2/bulk_processing/download

대량 처리 결과 CSV를 다운로드합니다.

Authorizations

API-KEYstringRequired

Your API key for authentication

Query parameters

file_urlstringRequired

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

get/webapi/v2/bulk_processing/download

GET /webapi/v2/bulk_processing/download?file_url=text HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

결과 삭제

delete

/webapi/v2/bulk_processing/results/{result_id}

ID로 대량 처리 결과(GA 또는 RAG)를 삭제합니다.

Authorizations

API-KEYstringRequired

Your API key for authentication

Path parameters

result_idstringRequired

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

Responses

200

No content

400

Invalid request parameters.

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

Internal server error.

delete/webapi/v2/bulk_processing/results/{result_id}

DELETE /webapi/v2/bulk_processing/results/{result_id} HTTP/1.1
Host: backend.alli.ai
API-KEY: YOUR_API_KEY
Accept: */*

No content

생성 답변 API

post

/webapi/generative_answer

생성적 답변 API는 비정형 텍스트 문서, Q&A, 심지어 복잡한 표에서도 답을 찾습니다. 여러 출처에서 정보를 종합하여 유저 쿼리에 대한 포괄적인 답변을 제공합니다.

Authorizations

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

querystringOptional

쿼리 문자열입니다.

modelstringOptional

답변을 생성할 때 선택한 LLM을 활용하십시오. 기본 모델은 GPT4o입니다. 사용 가능한 옵션은 문서를 True로 변경하십시오.

answerFormatstringOptional

답변의 형식을 결정하여 통합을 용이하게 만듭니다. 허용 가능한 값은 DRAFTJS 및 MARKDOWN입니다. 기본 형식은 DRAFTJS입니다.

isStatefulbooleanOptional

후속 질문을 사용하기 위해서는 이전 대화 역사가 필요합니다. 대화 역사는 threadId로 관리됩니다. isStateful 옵션을 True로 설정하고 threadId를 입력하면 이전 대화 역사를 True고하여 쿼리가 다시 작성됩니다. 기본값 = False.

threadIdstring · uuidOptional

threadId는 isStateful = True일 때 사용됩니다. 처음 대화를 시작할 때는 비워서 보내고, 그 다음 질의부터는 출력에서 threadId를 사용하여 보냅니다. 그러나 처음부터 threadId를 설정하려면 UUID로 작성하여 보내십시오. 예시 UUID - 36e7bb2b-1063-47ec-. 기본값 = None.

promptGroupIdstringOptional

프로젝트에서 답변 생성에 사용할 그룹 프롬프트를 선택해 주세요. ID는 설정 페이지 내에서 그룹 프롬프트를 볼 때 URL에 위치해 있습니다. 이는 특정 작업을 위해 수정된 여러 다른 그룹 프롬프트가 있는 프로젝트에 매우 유용한 옵션입니다.

modestringOptional

데이터를 스트림 또는 동기식으로 출력할지 여부. 현재 사용 가능한 값: sync 또는 stream (기본값=sync). 스트림 모드에서는 .json 문자열이 동기식과 동일한 출력 형식으로 스트리밍으로 출력됩니다.

clueTextbooleanOptional

단서를 사용하여 단서로 사용된 문서의 텍스트를 포함할지 여부. 기본값 = False. 단서가 활성화된 경우에만 작동합니다.

cluesbooleanOptional

출력에 생성 답변을 만드는 데 사용될 단서를 포함할지 여부. 기본값 = False.

includeCitationsbooleanOptional

Whether to include detailed citation information in the response. Citations provide structured references to source documents used in generating the answer. Default = False.

search_fromstring[]Optional

생성적 답변이 데이터를 찾기 위한 원본 데이터의 범위를 지정합니다. 현재 사용 가능한 값은 다음과 같습니다: 웹, 질의답변, 문서이며, 목록 형식으로 데이터를 입력합니다. 예를 들어 -> ["웹", "질의답변"]

temperaturenumberOptional

출력의 무작위성을 제어합니다. 값이 클수록 출력이 더 무작위가 됩니다. 기본값 = 0.

knowledgeBaseIdsstring[]Optional

검색을 특정 지식베이스 ID로 제한합니다.

folderIdsstring[]Optional

검색을 특정 폴더 ID로 제한합니다.

Responses

200

성공적으로 생성된 답변

application/json

answerobjectOptional

대시보드에 업로드된 문서에서 추출된 답변으로, answerFormat 매개변수에 따라 형식화되었습니다.

answerHashstringOptional

이는 피드백을 제공하거나 취소하기 위한 답변을 식별하는 데 사용됩니다.

confidencenumberOptional

AI 모델의 신뢰도를 보여줍니다. 0과 1 사이의 숫자 값으로 표시됩니다.

effectiveConfidencenumberOptional

쿼리 결과에 대한 피드백을 제공하면 AI 모델이 자동으로 학습합니다. 효과적인 신뢰도는 이러한 유저 및 에이전트의 피드백으로 조정된 점수입니다. 0과 1 사이의 숫자 값으로 표시됩니다.

documentIdstringOptional

답변이 추출된 문서의 ID입니다.

documentNamestringOptional

답변이 추출된 문서의 이름.

hashtagsarrayOptional

문서에 첨부된 해시태그.

pageNointegerOptional

답이 도출된 문서의 페이지 번호.

createdDatestring · dateOptional

문서가 업로드된 날짜.

agentFeedbackobjectOptional

이 문서에 대한 에이전트의 피드백(대시보드 및 REST 호출을 통해).

userFeedbackobjectOptional

이 문서에 대한 유저들의 피드백.

bodystringOptional

요청에서 returnPreview가 true이면, 문서 검색 미리보기의 html 본문이 표시됩니다.

cssstringOptional

요청에서 returnPreview가 true이면 문서 검색 미리보기의 CSS가 표시됩니다.

pdfPreviewstringOptional

요청에서 returnPdfPreview가 true인 경우, 답변이 강조된 문서의 PDF 미리보기를 위한 URL이 표시됩니다. URL은 다운로드 IP 허용 목록 설정을 사용하여 제한될 수 있음을 유의하십시오.

folderstringOptional

답이 Documents 데이터베이스 아래 폴더에서 발견되면, 폴더 이름이 여기에 반환됩니다.

editorstring[]Optional

문서에 편집자 접근 권한이 있는 에이전트의 이메일 목록 (Alli 대시보드에 설정되어 있는 경우).

viewerstring[]Optional

Alli 대시보드에 설정된 경우, 문서에 뷰어 액세스 권한이 있는 에이전트의 이메일 목록.

threadIdstringOptional

isStateful이 true일 때 후속 질문에 사용할 수 있는 UUID.

fuQuestionstringOptional

isStateful이 true일 때 유저를 위한 권장 후속 질문.

intentstringOptional

쿼리의 감지된 의도.

cluesarrayOptional

요청에 단서가 True인 경우, 답변을 생성하는 데 사용된 소스가 여기에 반환됩니다.

400

잘못된 요청

application/json

401

무단의

application/json

403

Access denied. The project is inactive or the request IP is not allowed.

429

속도 제한 초과

application/json

500

Internal server error.

post/webapi/generative_answer

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

{
  "query": "text",
  "model": "text",
  "answerFormat": "text",
  "isStateful": true,
  "threadId": "123e4567-e89b-12d3-a456-426614174000",
  "promptGroupId": "text",
  "mode": "text",
  "clueText": true,
  "clues": true,
  "includeCitations": true,
  "hashtags": {
    "qnaInclude": [
      "text"
    ],
    "qnaIncludeOption": "or",
    "qnaExclude": [
      "text"
    ],
    "qnaExcludeOption": "or",
    "docsInclude": [
      "text"
    ],
    "docsIncludeOption": "or",
    "docsExclude": [
      "text"
    ],
    "docsExcludeOption": "or"
  },
  "search_from": [
    "text"
  ],
  "temperature": 1,
  "source": {
    "sharedKnowledgeBaseNodeIds": [
      "text"
    ],
    "personalKnowledgeBaseNodeIds": [
      "text"
    ],
    "webSites": [
      "text"
    ]
  },
  "knowledgeBaseIds": [
    "text"
  ],
  "folderIds": [
    "text"
  ]
}

{
  "answer": {},
  "answerHash": "text",
  "confidence": 1,
  "effectiveConfidence": 1,
  "documentId": "text",
  "documentName": "text",
  "hashtags": [],
  "pageNo": 1,
  "createdDate": "2026-07-22",
  "agentFeedback": {},
  "userFeedback": {},
  "body": "text",
  "css": "text",
  "pdfPreview": "text",
  "folder": "text",
  "editor": [
    "text"
  ],
  "viewer": [
    "text"
  ],
  "threadId": "text",
  "fuQuestion": "text",
  "intent": "text",
  "clues": [],
  "citations": [
    {
      "index": 1,
      "clueId": "text",
      "source": "text",
      "title": "text",
      "pageNo": 1,
      "knowledgeBaseId": "text",
      "faqId": "text",
      "url": "text",
      "text": "text"
    }
  ]
}

Alli Retrieval API

post

/webapi/retrieval

Retrieval API는 Alli에 업로드된 문서에서 질문과 관련된 상위 N개의 페이지 정보를 얻을 수 있습니다. 이 API는 키워드 검색과 시맨틱 검색을 결합하여 쿼리와 가장 관련 있는 문서 페이지를 제공합니다.

Authorizations

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

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

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

use_rerankerbooleanOptional

Overrides the project's cognitive_config.use_reranker for this request. When omitted, the project config value is used.

reranker_candidates_numintegerOptional

Overrides the number of candidate pages passed to the reranker. Only effective when reranking is enabled. Defaults to 16 when omitted.

reranker_max_tokensintegerOptional

Overrides the maximum token length per candidate sent to the reranker. Only effective when reranking is enabled. Defaults to 1024 when omitted.

Responses

200

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

application/json

400

유효하지 않은 매개변수

application/json

401

Authentication failed. The API-KEY header is missing or invalid.

403

Access denied. The project is inactive or the request IP is not allowed.

500

내부 서버 오류

application/json

post/webapi/retrieval

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

{
  "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,
  "use_reranker": true,
  "reranker_candidates_num": 1,
  "reranker_max_tokens": 1
}

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

PreviousKnowledge Base NextApp Market

Last updated 1 month ago