Импорт внешнего содержимого

Импортируйте содержимое внешних источников в Базу знаний. Эти endpoints обрабатывают данные асинхронно.

Асинхронная обработка

Все endpoints импорта обрабатывают содержимое асинхронно. После отправки запроса данные извлекаются и добавляются в Базу знаний в фоне. Затем каждая импортированная статья автоматически обрабатывается и становится доступной самостоятельно. Отдельно запускать обучение не нужно.

Чтобы отслеживать прогресс:

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 строка, обязательный	URL видео YouTube
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 строка, обязательный	URL XML-карты сайта
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

---