외부 콘텐츠 가져오기

외부 소스의 콘텐츠를 지식 베이스로 가져옵니다. 이 엔드포인트는 콘텐츠를 비동기적으로 처리합니다.

비동기 처리

모든 가져오기 엔드포인트는 비동기로 처리합니다. 요청을 제출하면 백그라운드에서 콘텐츠를 수집하여 지식 베이스에 추가합니다. 가져온 각 문서는 자동으로 처리되어 개별 반영되며 재학습을 실행할 필요가 없습니다.

진행 상황을 확인하려면 다음을 따르세요.

1. 문서 목록에서 가져온 문서가 나타나는지 확인하세요.
2. 지식 베이스 설정 조회의 pending_embed_count가 0이 되거나 각 문서의 embed_state가 "embedded"가 될 때까지 기다리세요.

큰 가져오기 작업은 한 번에 모두 반영되지 않고 문서별로 점진적으로 반영됩니다.

웹사이트 수집

단일 웹페이지 또는 전체 웹사이트를 수집하여 콘텐츠를 가져옵니다.

권한 범위: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website

요청 본문

매개변수	설명
url 문자열, 필수	수집할 URL
mode 문자열	"individual"(기본값), "site_wide", "individual_with_summary"
phrases 문자열 배열	추출할 핵심 구문
html_selector 문자열	특정 콘텐츠를 지정하는 CSS 선택자

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/website \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/docs",
  "mode": "individual"
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/import_external/website",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"url": "https://example.com/docs", "mode": "individual"},
)
data = response.json()

응답 202 Accepted

{
  "status": "success",
  "url": "https://example.com/docs",
  "article": {}
}

YouTube 스크립트 가져오기

YouTube 동영상의 스크립트를 가져옵니다.

권한 범위: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube

요청 본문

매개변수	설명
url 문자열, 필수	YouTube 동영상 URL
toast_process_uuid 문자열, 필수	가져오기 과정을 추적할 UUID v4

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
  "toast_process_uuid": "550e8400-e29b-41d4-a716-446655440000"
}'

Python

import uuid
import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/import_external/youtube",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
        "toast_process_uuid": str(uuid.uuid4()),
    },
)

응답 202 Accepted: 스크립트는 비동기로 처리됩니다.

사이트맵 가져오기

XML 사이트맵의 모든 링크에서 콘텐츠를 가져옵니다.

권한 범위: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map

요청 본문

매개변수	설명
site_map 문자열, 필수	XML 사이트맵 URL
link_filter_regex 문자열	가져올 링크를 필터링하는 정규식(기본값: ".*")
html_selector 문자열	특정 콘텐츠를 지정하는 CSS 선택자
summarize 불리언	가져온 콘텐츠를 요약할지 여부(기본값: false)

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "site_map": "https://example.com/sitemap.xml"
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/import_external/site-map",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={"site_map": "https://example.com/sitemap.xml"},
)
data = response.json()

응답 202 Accepted

{
  "status": "success",
  "links": ["https://example.com/page1", "https://example.com/page2"]
}

링크 목록 수집

지정한 URL 목록에서 콘텐츠를 가져옵니다.

권한 범위: write_all

POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list

요청 본문

매개변수	설명
links 문자열 배열, 필수	수집할 URL 목록(비어 있지 않아야 함)
tags 문자열 배열	가져온 문서에 적용할 태그
html_selector 문자열	특정 콘텐츠를 지정하는 CSS 선택자
summarize 불리언	가져온 콘텐츠를 요약할지 여부(기본값: false)

Shell

curl -X POST https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "links": ["https://example.com/page1", "https://example.com/page2"],
  "tags": ["imported"]
}'

Python

import requests

response = requests.post(
    url="https://app.quickchat.ai/v1/api/knowledge_base/import_external/scrape-list",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "links": ["https://example.com/page1", "https://example.com/page2"],
        "tags": ["imported"],
    },
)
data = response.json()

응답 202 Accepted

{
  "status": "success",
  "links": ["https://example.com/page1", "https://example.com/page2"]
}

링크 삭제

이전에 가져온 URL 유형 문서를 지식 베이스에서 제거합니다.

권한 범위: write_all

DELETE https://app.quickchat.ai/v1/api/knowledge_base/import_external

요청 본문

매개변수	설명
links 문자열 배열, 필수	제거할 URL 목록(최소 1개)

참고

제공한 모든 URL은 지식 베이스에 URL 유형 문서로 존재해야 합니다. 일치하는 기존 문서가 없는 URL이 하나라도 있으면 404를 반환합니다.

Shell

curl -X DELETE https://app.quickchat.ai/v1/api/knowledge_base/import_external \
  -H 'Authorization: Bearer <API_TOKEN>' \
  -H 'Content-Type: application/json' \
  -d '{
  "links": ["https://example.com/page1"]
}'

Python

import requests

response = requests.delete(
    url="https://app.quickchat.ai/v1/api/knowledge_base/import_external",
    headers={"Authorization": "Bearer <API_TOKEN>"},
    json={
        "links": ["https://example.com/page1"],
    },
)

응답 200 OK

---