rageval-sdk 0.1.0__tar.gz

rageval_sdk-0.1.0/.gitignore

@@ -0,0 +1,38 @@
+# Python
+__pycache__/
+*.py[cod]
+*.pyo
+.venv/
+venv/
+env/
+*.egg-info/
+dist/
+build/
+.eggs/
+
+# 環境変数（絶対にコミットしない）
+.env
+.env.local
+.env.*.local
+
+# Node.js
+node_modules/
+.next/
+out/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# IDE
+.vscode/
+.idea/
+*.swp
+
+# テスト・カバレッジ
+.pytest_cache/
+.coverage
+htmlcov/
+
+# Vercel
+.vercel

rageval_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,77 @@
+Metadata-Version: 2.4
+Name: rageval-sdk
+Version: 0.1.0
+Summary: RAG evaluation SDK — RAGの回答品質を3行で計測
+Project-URL: Homepage, https://github.com/A-1ro/rag-eval
+Project-URL: Documentation, https://github.com/A-1ro/rag-eval#readme
+Project-URL: Issues, https://github.com/A-1ro/rag-eval/issues
+License: MIT
+Keywords: evaluation,llm,observability,rag
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.24.0
+Description-Content-Type: text/markdown
+
+# rag-eval SDK
+
+RAGアプリの回答品質を3行で計測できるSDKです。
+
+## インストール
+
+```bash
+pip install rag-eval
+```
+
+## 使い方
+
+```python
+from rag_eval import track
+
+# 既存のRAGコードに3行追加するだけ
+answer = your_rag_system.query(question)
+track(
+    question=question,
+    answer=answer,
+    chunks=[{"content": chunk.text, "source": chunk.source} for chunk in retrieved_chunks],
+    api_key="rag_eval_xxxx",  # または環境変数 RAG_EVAL_API_KEY
+    latency_ms=elapsed_ms,   # 任意
+)
+```
+
+### 非同期版（FastAPI / asyncio）
+
+```python
+from rag_eval import atrack
+
+await atrack(question=question, answer=answer, chunks=chunks)
+```
+
+### セルフホスト版
+
+```python
+track(
+    question=question,
+    answer=answer,
+    chunks=chunks,
+    api_url="https://your-own-server.com",  # または環境変数 RAG_EVAL_API_URL
+    api_key="your-key",
+)
+```
+
+## 環境変数
+
+| 変数名 | 説明 |
+|--------|------|
+| `RAG_EVAL_API_KEY` | APIキー |
+| `RAG_EVAL_API_URL` | APIのURL（セルフホスト時） |
+
+## ライセンス
+
+MIT

rageval_sdk-0.1.0/README.md

@@ -0,0 +1,56 @@
+# rag-eval SDK
+
+RAGアプリの回答品質を3行で計測できるSDKです。
+
+## インストール
+
+```bash
+pip install rag-eval
+```
+
+## 使い方
+
+```python
+from rag_eval import track
+
+# 既存のRAGコードに3行追加するだけ
+answer = your_rag_system.query(question)
+track(
+    question=question,
+    answer=answer,
+    chunks=[{"content": chunk.text, "source": chunk.source} for chunk in retrieved_chunks],
+    api_key="rag_eval_xxxx",  # または環境変数 RAG_EVAL_API_KEY
+    latency_ms=elapsed_ms,   # 任意
+)
+```
+
+### 非同期版（FastAPI / asyncio）
+
+```python
+from rag_eval import atrack
+
+await atrack(question=question, answer=answer, chunks=chunks)
+```
+
+### セルフホスト版
+
+```python
+track(
+    question=question,
+    answer=answer,
+    chunks=chunks,
+    api_url="https://your-own-server.com",  # または環境変数 RAG_EVAL_API_URL
+    api_key="your-key",
+)
+```
+
+## 環境変数
+
+| 変数名 | 説明 |
+|--------|------|
+| `RAG_EVAL_API_KEY` | APIキー |
+| `RAG_EVAL_API_URL` | APIのURL（セルフホスト時） |
+
+## ライセンス
+
+MIT

rageval_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rageval-sdk"
+version = "0.1.0"
+description = "RAG evaluation SDK — RAGの回答品質を3行で計測"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "MIT" }
+keywords = ["rag", "llm", "evaluation", "observability"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+dependencies = ["httpx>=0.24.0"]
+
+[project.urls]
+Homepage = "https://github.com/A-1ro/rag-eval"
+Documentation = "https://github.com/A-1ro/rag-eval#readme"
+Issues = "https://github.com/A-1ro/rag-eval/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["rag_eval"]

rageval_sdk-0.1.0/rag_eval/__init__.py

@@ -0,0 +1,4 @@
+from .tracker import track, atrack
+
+__all__ = ["track", "atrack"]
+__version__ = "0.1.0"

rageval_sdk-0.1.0/rag_eval/tracker.py

@@ -0,0 +1,96 @@
+import os
+from typing import Optional
+
+import httpx
+
+DEFAULT_API_URL = "https://rag-eval-api.vercel.app"
+
+
+def track(
+    question: str,
+    answer: str,
+    chunks: Optional[list] = None,
+    api_key: Optional[str] = None,
+    api_url: Optional[str] = None,
+    latency_ms: Optional[int] = None,
+) -> Optional[str]:
+    """
+    RAGの質問・回答・チャンクをCollector APIに送信する。
+
+    失敗してもRAG本体を止めない（例外を握りつぶす）。
+
+    Args:
+        question: ユーザーの質問
+        answer: RAGの回答
+        chunks: 取得されたチャンクのリスト [{"content": "...", "source": "..."}]
+        api_key: APIキー（未指定の場合は RAG_EVAL_API_KEY 環境変数を使用）
+        api_url: APIのURL（未指定の場合はデフォルトのSaaS URLを使用）
+        latency_ms: RAGの応答時間（ミリ秒）
+
+    Returns:
+        evaluation_id（成功時）または None（失敗時）
+    """
+    url = (api_url or os.getenv("RAG_EVAL_API_URL") or DEFAULT_API_URL).rstrip("/")
+    key = api_key or os.getenv("RAG_EVAL_API_KEY")
+
+    if not key:
+        return None
+
+    payload = {
+        "question": question,
+        "answer": answer,
+        "chunks": chunks or [],
+        "latency_ms": latency_ms,
+    }
+
+    try:
+        response = httpx.post(
+            f"{url}/api/track",
+            json=payload,
+            headers={"X-API-Key": key},
+            timeout=5.0,
+        )
+        response.raise_for_status()
+        return response.json().get("id")
+    except Exception:
+        return None
+
+
+async def atrack(
+    question: str,
+    answer: str,
+    chunks: Optional[list] = None,
+    api_key: Optional[str] = None,
+    api_url: Optional[str] = None,
+    latency_ms: Optional[int] = None,
+) -> Optional[str]:
+    """
+    非同期版 track()。asyncio / FastAPI 環境向け。
+
+    引数・戻り値は track() と同じ。
+    """
+    url = (api_url or os.getenv("RAG_EVAL_API_URL") or DEFAULT_API_URL).rstrip("/")
+    key = api_key or os.getenv("RAG_EVAL_API_KEY")
+
+    if not key:
+        return None
+
+    payload = {
+        "question": question,
+        "answer": answer,
+        "chunks": chunks or [],
+        "latency_ms": latency_ms,
+    }
+
+    try:
+        async with httpx.AsyncClient() as client:
+            response = await client.post(
+                f"{url}/api/track",
+                json=payload,
+                headers={"X-API-Key": key},
+                timeout=5.0,
+            )
+        response.raise_for_status()
+        return response.json().get("id")
+    except Exception:
+        return None