Fess APIガイド

はじめに

はじめに

• 対象読者
• お読みになる前に
• API利用の前提条件
• オンラインでのアクセス
• 技術的なサポートの連絡先
• 関連サードパーティー Web サイトの参照
• コメントおよび提案の送付方法

APIクイックスタート

• 5分で始めるAPI
• Postman での利用
• プログラミング言語別サンプル
• APIバージョン対応表
• トラブルシューティング
• 次のステップ

共通仕様

APIの概要

• Fess の提供するAPI
• ベースURL
• レスポンスエンベロープ
• エラーレスポンス
• 認証とセッション
• ストリーミング形式
• APIの種類

検索API

検索API

• ドキュメントの検索
• 全ドキュメントの取得（スクロール検索・NDJSON）

ラベルAPI

• ラベルの取得
• 使用例
• エラーレスポンス

人気ワードAPI

• 人気ワード一覧の取得
• 使用例
• エラーレスポンス

サジェストAPI

• サジェストワード一覧の取得
• 使用例
• エラーレスポンス

関連クエリ・関連コンテンツAPI

• 関連クエリの取得
• 関連コンテンツの取得

Health API

• 状態の取得
• 使用例
• レスポンス・エラーレスポンス

認証・UI

認証・セッションAPI

• 概要
• 共通のユーザー情報 (UserPayload)
• 認証状態の取得
• ログイン
• ログアウト
• パスワード変更

UI設定API

• 概要
• UI設定の取得

ユーザー機能API

お気に入りAPI

• お気に入りドキュメント一覧の取得
• お気に入り状態の取得
• お気に入りの登録

クリックログAPI

• クリックの記録

キャッシュAPI

• キャッシュされたドキュメントの取得

AIチャットAPI

Chat API

• 概要
• 前提条件
• 認証とCSRF
• レート制限
• POST /chat
• POST /chat/stream
• DELETE /chat/sessions/{session_id}
• セキュリティ
• 参考情報

管理API

Admin API リファレンス

• Admin API 概要
• WebConfig API
• FileConfig API
• DataConfig API
• Documents API
• CrawlingInfo API
• FailureUrl API
• Backup API
• Scheduler API
• JobLog API
• User API
• Role API
• Group API
• AccessToken API
• LabelType API
• KeyMatch API
• BoostDoc API
• ElevateWord API
• BadWord API
• RelatedContent API
• RelatedQuery API
• Suggest API
• General API
• SystemInfo API
• Stats API
• Log API
• SearchLog API
• Storage API
• Plugin API
• Dict API