Documents

文書の作成

テキストは JSON（content と content_type）、PDF などのリッチの形式は multipart/form-data（file）で送る。

source_id を省くと既定のソースに入る。同じ external_id で同じ内容をもう一度送ると、作らずに 200 で既存を返す。

本文の上限は JSON 6 MiB・multipart 16 MiB。テキストは分割の上限が先に効き、実際は約 1.5 MiB まで。

post/knowledge/documents

Request

  • Base URL: https://api.leafchat.app/api/v1
  • URL: https://api.leafchat.app/api/v1/knowledge/documents
  • Auth: HTTP bearer

Request body

source_idstring
folder_idstring
external_idstring

外部 ID は、ソースの中で一意の文字列です。UTF-8 で 512 バイトまで、Unicode の NFC にそろえ、/ で区切れます。空の区切り・.・..・区切りの前後の空白・制御文字・\ は使えません。例：faq/shipping、渋谷店/営業時間.md

filenamestring required
contentstring required
content_type'text/markdown' | 'text/plain' | 'application/json' required

Example request

{
  "external_id": "faq/shipping"
}

Response

同じ外部 ID・同じ内容の文書が既にあった

document_idstring required
revision_idstring required
createdboolean required

新しい文書（POST）か新しい版（PATCH・復元・POST の上書き）を作ったか。同じ内容なら false で、状態は 200

replacedboolean

POST だけ。同じフォルダに同じ名前の文書があり、新しく作らずにその文書を上書きしたら true（状態は 200、document_id はその文書）。外部 ID つきの作成は名前で照合しない

Changes

No recorded changes to this operation across all 1 revision of this API.