genflux 0.1.1

Python SDK for GenFlux API - RAG Evaluation Platform

GenFlux Python SDK

RAG（検索拡張生成）システムの安全性を評価することを目的とした AI Safety のための GenFlux Platform 公式 Python SDK です。
Python から数行のコードで、回答品質のスコアリング、RedTeam によるセキュリティテスト、ポリシーチェックを実行できます。

---

📋 目次

• 特徴
• セットアップ
• クイックスタート
• ドキュメント
• リリース履歴・破壊的変更
• トラブルシューティング

---

🎯 特徴

• 豊富な評価指標 — 回答の忠実度・関連性、有害性・バイアスなど 12 種類のメトリックで RAG の品質を数値化できます。
• セキュリティテスト（RedTeam） — 攻撃シナリオに基づく静的・動的テストで、AI の堅牢性を確認できます。
• ポリシーチェック — AI 事業者ガイドラインなどへの準拠を、API から自動チェックできます。
• 待ち時間を気にしなくてよい設計 — 重い評価はジョブで非同期実行され、SDK 側は結果を待つだけのシンプルなコードで書けます。
• 進捗が見える — 実行中はプログレスバーで進捗が表示されます。
• 型付きで書きやすい — レスポンスは Pydantic で型付けされているため、補完やミスを防ぎながら開発ができます。

---

🚀 セットアップ

前提条件

• Python 3.11 以上

API Key の発行

GenFlux SDK で使用する API Key は GenFlux Platform ダッシュボード から発行してください。

インストール

git clone <repository-url>
cd genflux-python-sdk

# 依存関係をインストール
uv sync

API Key の設定

環境変数 GENFLUX_API_KEY に API Key を設定してください。

export GENFLUX_API_KEY="your_api_key_here"

---

🎯 クイックスタート

最も簡単な使い方から始めましょう。詳細は QUICKSTART.md を参照してください。

最初の評価を実行

from genflux import GenFlux

# クライアント初期化（環境変数 GENFLUX_API_KEY を使用）
client = GenFlux()

# 評価を実行（デフォルトの Config を使用）
evaluator = client.evaluation()
result = evaluator.faithfulness(
    question="What is Python?",
    answer="Python is a programming language.",
    contexts=["Python is a high-level programming language."]
)

# 結果表示
print(f"Score: {result.score}")
print(f"Reason: {result.reason}")

期待される出力:

Evaluation |██████████████████████████████████████████████████| 100.0% Complete
Score: 0.95
Reason: The answer is based on the provided context.

たったこれだけ！わずか数行で評価を実行できます。

---

📚 ドキュメント

初心者向け

• QUICKSTART.md - Config不要で今すぐ試せる簡単な使い方
  • 最小限のコードで評価を実行
  • Config作成から評価まで一気通貫

実践的な使い方

• WORKFLOW.md - 本格的なワークフロー例
  • バッチ評価
  • 複数メトリック評価
  • CI/CD統合
  • エラーハンドリング

リファレンス

• API_REFERENCE.md - 機能の全体像とAPI仕様
  • 全メソッドの詳細
  • パラメータ説明
  • 例外処理

その他

• EXAMPLES.md - 実践的なサンプルコード集

---

📌 リリース履歴・破壊的変更

• CHANGELOG.md … バージョンごとの変更内容。破壊的変更は各リリースの「Breaking changes」に記載します。
• docs/MIGRATION.md … 破壊的変更がある場合の移行手順（例: 1.x → 2.0 への移行）。手順はここにまとめ、CHANGELOG の Breaking changes からリンクします。

メジャーアップデート時は上記 2 つを確認してください。

---

🔧 トラブルシューティング

問題1: AuthenticationError: Invalid API Key

原因: API Key が設定されていない、または無効です。

解決方法: 環境変数 GENFLUX_API_KEY に有効な API Key を設定してください。GenFlux Platform ダッシュボードから取得できます。

---

問題2: ModuleNotFoundError: No module named 'genflux'

原因: SDK がインストールされていません。

解決方法: セットアップ に沿ってインストールしてください。

📞 サポート

ドキュメント

• クイックスタート
• ワークフロー
• API リファレンス
• サンプルコード集

お問い合わせ

質問・不具合報告・機能要望は GitHub Issues に記載してください。 または下記のメールアドレスにお問い合わせください。

• GitHub Issues（genflux-python-sdk）
• Email: [e-mail]

---

📄 ライセンス

MIT License - 詳細は LICENSE ファイルを参照してください。

---

GenFlux - RAG Evaluation Made Simple