지식 베이스

지식 베이스는 AI 에이전트 전문 지식의 핵심입니다. 이 엔드포인트로 설정을 관리하고 콘텐츠 처리 상태를 확인하세요.

지식 베이스는 AI 에이전트 전문 지식의 핵심으로, 질문에 답하는 데 사용하는 모든 정보를 담고 있습니다. 이 엔드포인트로 지식 베이스 설정을 관리하고 콘텐츠 처리 상태를 추적할 수 있습니다.

지식 베이스는 직접 작성하거나 웹사이트에서 가져오거나 파일로 업로드한 문서를 사용합니다. 재학습 단계는 없습니다. 생성, 수정, 삭제한 모든 문서는 백그라운드에서 자동 처리되며 완료되는 즉시 대화에 반영됩니다.

설정 조회

지식 베이스 설정을 조회합니다.

권한 범위: read_all

GET https://app.quickchat.ai/v1/api/knowledge_base/

Shell
Python

curl https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.get(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)
data = response.json()

응답 200 OK

{
  "one_word_description": "Support Agent",
  "short_description": "A helpful customer support assistant.",
  "ai_commands": ["Be polite", "Stay on topic"],
  "pending_embed_count": 0,
  "failed_embed_count": 0
}

필드	설명
`one_word_description` 문자열	AI 에이전트 이름. 대시보드: 정체성 > AI 페르소나 > 이름
`short_description` 문자열	시스템 프롬프트 / 메인 프롬프트. 대시보드: 정체성 > AI 페르소나 > 메인 프롬프트
`ai_commands` 문자열 배열	배열 항목마다 하나의 동작 가이드라인. 대시보드: 정체성 > AI 페르소나 > 가이드라인. 최대 250개 항목, 항목당 5,000자, 전체 합계 10,000자입니다.
`pending_embed_count` 정수	아직 처리 중인 문서 수. `0`이면 제출한 모든 내용이 반영되었습니다.
`failed_embed_count` 정수	처리가 실패한 문서 수. 실패한 문서 재시도로 다시 처리하세요.

쓰기 작업 후 이 엔드포인트를 폴링하여 pending_embed_count가 0이 될 때까지 기다리세요. 개별 문서 상태는 문서의 embed_state 필드에서도 확인할 수 있습니다.

세 필드(one_word_description, short_description, ai_commands)는 챗봇 설정과 공유됩니다. 어느 엔드포인트로 수정해도 같은 기반 데이터가 바뀝니다.

설정 수정

권한 범위: write_all

PATCH https://app.quickchat.ai/v1/api/knowledge_base/

요청 본문

매개변수	설명
`one_word_description` 문자열	AI 에이전트 이름
`short_description` 문자열	시스템 프롬프트 / AI 에이전트 설명. API는 모든 요금제에서 최대 25,000자를 허용합니다. 앱 편집기는 15,000자부터 시작하는 요금제 한도를 적용합니다. 초과하면 `422`를 반환합니다.
`ai_commands` 문자열 배열	배열 항목마다 하나의 AI 가이드라인. 최대 250개 항목, 항목당 5,000자, 전체 합계 10,000자입니다. 초과하면 `422`를 반환합니다.

배열 항목 하나가 가이드라인 하나이며 보낸 그대로 저장됩니다. 세미콜론을 포함한 문장부호도 유지됩니다. 이전에는 ;가 포함된 가이드라인이 두 개로 나뉘어 반환되었지만 이제 이를 피하려고 세미콜론을 빼지 않아도 됩니다.

이 엔드포인트는 이전에 길이 제한 없이 가이드라인을 받았습니다. 이제 위 한도를 적용하며 챗봇 설정과 정확히 같습니다.

가이드라인을 유지하려면 ai_commands를 생략하거나 null을 보내세요. 모두 지우려면 []를 보내세요.

Shell
Python

curl -X PATCH https://app.quickchat.ai/v1/api/knowledge_base/ \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "one_word_description": "Sales Bot"
}'

import requests

response = requests.patch(
    url="https://app.quickchat.ai/v1/api/knowledge_base/",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"one_word_description": "Sales Bot"},
)
data = response.json()

응답 200 OK: 수정된 지식 베이스 설정을 반환합니다(설정 조회와 같은 스키마).

실패한 문서 재시도

처리에 실패한 모든 문서를 다시 처리합니다. 이미 반영되었거나 처리 중인 문서는 그대로 두며 반복 호출해도 안전합니다.

실패한 문서는 자동으로도 재시도하므로 기다리고 싶지 않을 때만 이 엔드포인트가 필요합니다.

권한 범위: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds

Shell
Python

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds \
  -H 'Authorization: Bearer <API_TOKEN>'

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/retry_failed_embeds",
    headers={"Authorization": "Bearer <API_TOKEN>"},
)

응답 200 OK

{
  "retried": 2
}

필드	설명
`retried` 정수	재처리 대기열에 추가한 실패 문서 수