APIを活用したナレッジベースのメンテナンス
認証や呼び出し方法はサービスAPIと同様ですが、生成される各ナレッジベースAPIトークンには、現在のアカウントでアクセス可能なすべてのナレッジベースを操作する権限が付与されています。データの安全性には十分ご注意ください。
ナレッジベースAPI活用のメリット
APIによるナレッジベース管理はデータ処理効率を飛躍的に向上させます。コマンドラインからのデータ同期や自動化操作を容易に実現でき、UI操作の煩雑さから解放されます。
主なメリット：
自動同期: データシステムとDifyナレッジベースをシームレスに連携し、効率的なワークフローを構築。
総合管理: ナレッジベースリスト、ドキュメントリスト、詳細検索機能を提供し、カスタム管理インターフェースの構築が可能。
柔軟なアップロード: テキスト直接入力とファイルアップロードを両方サポート、チャンク単位の一括操作に対応。
生産性向上: 手動作業時間を削減し、Difyプラットフォームの利用体験を最適化。
使用方法
ナレッジベース管理画面左側ナビゲーションのAPIページにアクセス。APIドキュメントの閲覧や、APIキーによる認証情報の管理が可能です。
API呼び出しの例
テクストを通してドキュメントを作成する
入力例：
出力例：
ファイルを通してドキュメントを作成する
入力例：
出力例：
空白のナレッジベースを作成する
空のデータセットを作成するためだけに使用
入力例：
出力例：
ナレッジベースリスト
入力例：
出力例：
ナレッジベースの削除
入力例：
出力例：
テクストを通してドキュメントを更新する
このAPIは存在しているナレッジベースにしか使えます。
入力例：
出力例：
ファイルを通してドキュメントを更新する
このAPIは存在しているナレッジベースにしか使えます。
入力例：
出力例：
ドキュメント埋め込みステータス(進捗状況)の取得
入力例：
出力例：
ドキュメントの削除
入力例：
出力例：
ナレッジベースのドキュメントのリスト
入力例：
出力例：
新しセグメントを増加
入力例：
出力例：
ドキュメントのセグメントを見つける
入力例：
出力例：
ドキュメントのセグメントの削除
入力例：
出力例：
ドキュメントのセグメントの更新
入力例：
出力例：
ナレッジベースのメタデータフィールドを追加する
入力例：
出力例：
ナレッジベースのメタデータフィールドを修正する
入力例：
出力例：
ナレッジベースのメタデータフィールドを削除する
入力例：
出力例：
ナレッジベースのメタデータにある組み込みフィールドを有効化/無効化する
入力例：
出力例：
ドキュメントのメタデータを修正する（値の割り当て）
入力例：
出力例：
データセットのメタデータリスト
入力例：
出力例：
エラーメッセージ
no_file_uploaded
400
ファイルをアップロードしてください
too_many_files
400
1つのファイルのみアップロードできます
file_too_large
413
ファイルサイズが制限を超えています
unsupported_file_type
415
サポートされていないファイルタイプです。現在、以下の形式のみをサポートしています：txt、 markdown、 md、 pdf、 html、 xlsx、 docx、 csv
high_quality_dataset_only
400
現在の操作は「高品質」のナレッジベースのみをサポートしています
dataset_not_initialized
400
ナレッジベースはまだ初期化中またはインデックス中です。お待ちください
archived_document_immutable
403
アーカイブされたドキュメントは編集できません
dataset_name_duplicate
409
ナレッジベース名がすでに存在します。ナレッジベース名を変更してください
invalid_action
400
無効な操作です
document_already_finished
400
ドキュメントの処理がすでに完了しています。ページを更新するか、ドキュメントの詳細を確認してください
document_indexing
400
ドキュメントが処理中のため、編集できません
invalid_metadata
400
メタデータの内容が正しくありません。確認して検証してください
Last updated