クロールジョブを作成
クロールジョブを作成
指定した深さとページ数の上限で、指定URLをクロールするクロールジョブを作成します。
ヘッダー
xi-api-key
リクエスト
This endpoint expects an object.
url
ユーザーとのやり取りのためにエージェントがアクセスできるドキュメントページのURL。
max_pages
クロールするページの最大数(1~10,000)。デフォルトは1000です。
pattern
設定した場合、このパターンに一致するURLのみが含まれます。
sitemap_urls
サイトマップからクロールするURLのリスト(任意。自動URL検出を上書きします)。
parent_folder_id
設定すると、作成されたドキュメントまたはフォルダは指定したフォルダ内に配置されます。
enable_auto_sync
このURLドキュメントで自動同期を有効にするかどうか。
auto_remove
URLが利用できなくなった場合にドキュメントを自動削除するかどうか。自動同期が有効な場合にのみ適用されます。
auto_discover
自動同期中に、すでにクロール済みのページからリンクされている新しいページを自動的に検出して追加します。enable_auto_sync=trueが必要です。
minimum_frequency_days
対象となる基盤ドキュメントを更新する最小頻度(日数)。実際の間隔はこれより短くなる場合がありますが、長くなることはありません。デフォルトは7で、親フォルダの頻度がより厳しい場合はそれに合わせて短縮されます。自動同期が有効な場合にのみ適用されます。
max_depthDeprecated
非推奨。このフィールドは何も行わず、将来のバージョンで削除されます。
レスポンス
成功レスポンス。
id
type
許可された値:
root_folder_id
status
created_at
folder_path
ルートから親フォルダまでの、ルートフォルダにつながるフォルダパスセグメント。
エラー
422
Unprocessable Entity Error