Import External Content

外部ソースから Knowledge Base にコンテンツをインポートします。これらのエンドポイントはコンテンツを非同期で処理します。

Async Processing

すべてのインポートエンドポイントは、コンテンツを非同期で処理します。インポートリクエストを送信した後、コンテンツはバックグラウンドでスクレイピングされ、Knowledge Base に追加されます。インポートが完了すると、Knowledge Base は自動的に再トレーニング対象としてマークされます。

進捗を監視するには：

1. Get Knowledge Base Settings で retrain_state を確認します。"to_be_retrained"、"in_progress"、"up_to_date" へと変化します
2. List Articles を使って、インポートされた記事が表示されることを確認します

Scrape Website

単一のウェブページまたはウェブサイト全体をスクレイピングし、コンテンツをインポートします。

Scope: write_all

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

Request Body

Parameter	Description
url string, required	スクレイピングする URL
mode string	"individual"（デフォルト）、"site_wide"、または "individual_with_summary"
phrases array of strings	抽出するキーフレーズ
html_selector string	特定のコンテンツを対象とする 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()

Response 202 Accepted

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

Import YouTube Transcript

YouTube 動画の文字起こしをインポートします。

Scope: write_all

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

Request Body

Parameter	Description
url string, required	YouTube 動画の URL
toast_process_uuid string, required	インポートプロセスを追跡するための 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()),
    },
)

Response 202 Accepted — 文字起こしは非同期で処理されます。

Import Sitemap

XML サイトマップ内のすべてのリンクからコンテンツをインポートします。

Scope: write_all

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

Request Body

Parameter	Description
site_map string, required	XML サイトマップへの URL
link_filter_regex string	インポートするリンクをフィルタする正規表現（デフォルト：".*"）
html_selector string	特定のコンテンツを対象とする CSS セレクター
summarize boolean	インポートしたコンテンツを要約するかどうか（デフォルト：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()

Response 202 Accepted

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

Scrape List of Links

特定の URL リストからコンテンツをインポートします。

Scope: write_all

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

Request Body

Parameter	Description
links array of strings, required	スクレイピングする URL のリスト（空でないこと）
tags array of strings	インポートする記事に適用するタグ
html_selector string	特定のコンテンツを対象とする CSS セレクター
summarize boolean	インポートしたコンテンツを要約するかどうか（デフォルト：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()

Response 202 Accepted

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

Delete Links

以前にインポートした URL タイプの記事を Knowledge Base から削除します。

Scope: write_all

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

Request Body

Parameter	Description
links array of strings, required	削除する URL のリスト（最小 1 件）

ノート

提供されたすべての URL が、URL タイプの記事として Knowledge Base に存在している必要があります。いずれかの 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"],
    },
)

Response 200 OK

---