はじめにKnowledge BaseDocuments

Create knowledge base document from URL

Create a knowledge base document generated by scraping the given webpage.

ヘッダー

xi-api-keystringオプション

リクエスト

This endpoint expects an object.
urlstring必須
URL to a page of documentation that the agent will have access to in order to interact with users.
namestringオプション>=1 character

A custom, human-readable name for the document.

parent_folder_idstringオプション
If set, the created document or folder will be placed inside the given folder.
enable_auto_syncbooleanオプションデフォルト値 false

Whether to enable auto-sync for this URL document.

auto_removebooleanオプションデフォルト値 false

Whether to automatically remove the document if the URL becomes unavailable. Only applicable when auto-sync is enabled.

minimum_frequency_daysintegerオプション1-180

Minimum frequency (in days) at which the document is refreshed. The actual interval may be shorter, never longer. Defaults to 7, tightened to the parent folder’s frequency if that is stricter. Only applicable when auto-sync is enabled.

レスポンス

Successful Response
idstring
namestring
folder_pathlist of objectsオプション
The folder path segments leading to this entity, from root to parent folder.

エラー

422
Documents Create from URL Request Unprocessable Entity Error