Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,25 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/ja/1.1.0/),

---

## 0.1.3
Released: 2026-07-04

### Added

- `GenFlux` / `GenFluxError` を互換 alias として復元し、既存ユーザーの `from genflux import GenFlux` / `GenFluxError` import を維持
- `Genflux` / `GenfluxError` を推奨名として残しつつ、新旧両方の import をテストで固定

### Changed

- README、API Reference、LLM context、サンプル、生成スクリプトの GENFLUX ブランド表記と SDK ドキュメントを整理
- `MetricResult` の docstring と評価メトリクス仕様ドキュメントを追加

### Breaking changes

- なし。旧名 `GenFlux` / `GenFluxError` は互換 alias として維持

---

## 0.1.2
Released: 2026-03-02

Expand Down Expand Up @@ -66,7 +85,8 @@ Released: 2026-03-02

- なし(初回リリースのため)

[Unreleased]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.2...HEAD
[Unreleased]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.3...HEAD
[0.1.3]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.2...v0.1.3
[0.1.2]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.1...v0.1.2
[0.1.1]: https://github.com/elith-co-jp/genflux-python-sdk/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.0
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
GENFLUX Platform 公式 Python SDK。RAG システムの回答品質スコアリング、セキュリティテスト、ポリシーチェックを Python から実行できます。
</p>

[![Version](https://img.shields.io/badge/version-0.1.2-blue.svg)](https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.2)
[![Version](https://img.shields.io/badge/version-0.1.3-blue.svg)](https://github.com/elith-co-jp/genflux-python-sdk/releases/tag/v0.1.3)
[![Python](https://img.shields.io/badge/python-3.11%2B-blue.svg)](https://www.python.org/downloads/)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

Expand Down
6 changes: 3 additions & 3 deletions docs/API_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- このファイルは自動生成されています。手動で編集しないでください。 -->
<!-- Generated by: python scripts/generate_api_reference.py --mode external -->
<!-- Generated at: 2026-04-10 14:02 UTC -->
<!-- Generated at: 2026-07-04 13:16 UTC -->

# GENFLUX Python SDK - API Reference

Expand Down Expand Up @@ -1306,6 +1306,6 @@ result = client.jobs.wait(job.id, callback=callback)

---

*Auto-generated at 2026-04-10 14:02 UTC by `scripts/generate_api_reference.py`*
*Auto-generated at 2026-07-04 13:16 UTC by `scripts/generate_api_reference.py`*

<!-- source-hash: 3264d16b75b7d4d7 -->
<!-- source-hash: 07ed6bb5360e8be3 -->
6 changes: 3 additions & 3 deletions docs/DEVELOPER_API_REFERENCE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!-- このファイルは自動生成されています。手動で編集しないでください。 -->
<!-- Generated by: python scripts/generate_api_reference.py --mode developer -->
<!-- Generated at: 2026-04-10 14:02 UTC -->
<!-- Generated at: 2026-07-04 13:16 UTC -->

# GENFLUX Python SDK - Developer API Reference

Expand Down Expand Up @@ -1647,6 +1647,6 @@ job.wait()用のプログレスコールバックを作成します。

---

*Auto-generated at 2026-04-10 14:02 UTC by `scripts/generate_api_reference.py`*
*Auto-generated at 2026-07-04 13:16 UTC by `scripts/generate_api_reference.py`*

<!-- source-hash: 3264d16b75b7d4d7 -->
<!-- source-hash: 07ed6bb5360e8be3 -->
4 changes: 2 additions & 2 deletions llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ Priority: `GENFLUX_API_BASE_URL` > `GENFLUX_ENVIRONMENT` > default (`"prod"`).
Everything exported from `genflux/__init__.py`:

```python
# Clients: Genflux, ConfigClient, EvaluationClient, JobsClient, ReportsClient
# Clients: Genflux, GenFlux, ConfigClient, EvaluationClient, JobsClient, ReportsClient
# Models: Config, ConfigCreate, ConfigUpdate, ConfigListResponse, Job, JobProgress, MetricResult, Report, ReportSummary, ReportDetails, EvaluationSummary, RedTeamSummary, PolicySummary, CategoryBreakdown, FailedCase, Violation
# Errors: GenfluxError, APIError, AuthenticationError, NotFoundError, ValidationError, TimeoutError, JobFailedError, RateLimitError, ConfigNotFoundError, ResourceNotFoundError
# Errors: GenfluxError, GenFluxError, APIError, AuthenticationError, NotFoundError, ValidationError, TimeoutError, JobFailedError, RateLimitError, ConfigNotFoundError, ResourceNotFoundError
# Utils: ProgressBar, create_progress_callback
```

Expand Down
2 changes: 1 addition & 1 deletion llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Priority: `GENFLUX_API_BASE_URL` > `GENFLUX_ENVIRONMENT` > default (`"prod"`).

## Tech Stack

- Python >= 3.11, SDK version 0.1.2
- Python >= 3.11, SDK version 0.1.3
- HTTP client: httpx
- Data models: Pydantic v2 (BaseModel) + dataclasses
- Build: hatchling, managed with uv
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "hatchling.build"

[project]
name = "genflux"
version = "0.1.2"
version = "0.1.3"
description = "Python SDK for GENFLUX API - RAG Evaluation Platform"
readme = "README.md"
license = "MIT"
Expand Down
3 changes: 1 addition & 2 deletions scripts/generate_llms_txt.py
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ def _generate_llms_full_txt(info: SDKInfo) -> str:
lines.append("")
lines.append("```python")
# Group them
clients = [n for n in info.public_api if n.endswith("Client") or n == "Genflux"]
clients = [n for n in info.public_api if n.endswith("Client") or n in ("Genflux", "GenFlux")]
_util_names = ("ProgressBar", "create_progress_callback")
models = [
n for n in info.public_api
Expand Down Expand Up @@ -985,4 +985,3 @@ def main() -> int:

if __name__ == "__main__":
sys.exit(main())

7 changes: 6 additions & 1 deletion src/genflux/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
APIError,
AuthenticationError,
ConfigNotFoundError,
GenFluxError,
GenfluxError,
JobFailedError,
NotFoundError,
Expand Down Expand Up @@ -48,11 +49,14 @@
# Progress
from genflux.progress import ProgressBar, create_progress_callback

__version__ = "0.1.2"
GenFlux = Genflux

__version__ = "0.1.3"

__all__ = [
# Main Client
"Genflux",
"GenFlux",
# Specialized Clients
"ConfigClient",
"EvaluationClient",
Expand Down Expand Up @@ -80,6 +84,7 @@
"create_progress_callback",
# Exceptions
"GenfluxError",
"GenFluxError",
"APIError",
"AuthenticationError",
"NotFoundError",
Expand Down
2 changes: 2 additions & 0 deletions src/genflux/exceptions/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
APIError,
AuthenticationError,
ConfigNotFoundError,
GenFluxError,
GenfluxError,
JobFailedError,
NotFoundError,
Expand All @@ -15,6 +16,7 @@

__all__ = [
"GenfluxError",
"GenFluxError",
"APIError",
"AuthenticationError",
"NotFoundError",
Expand Down
4 changes: 3 additions & 1 deletion src/genflux/exceptions/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ class GenfluxError(Exception):
pass


GenFluxError = GenfluxError


class APIError(GenfluxError):
"""APIリクエストが失敗しました。"""

Expand Down Expand Up @@ -255,4 +258,3 @@ def __init__(self, resource_type: str, resource_id: str):
self.resource_type = resource_type
self.resource_id = resource_id
super().__init__(f"{resource_type} {resource_id} not found")

16 changes: 16 additions & 0 deletions tests/test_backward_compatibility.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
from genflux import (
GenFlux,
Genflux,
GenFluxError,
GenfluxError,
)


def test_legacy_client_name_aliases_preferred_client_name() -> None:
"""Legacy client import remains an alias of the preferred client name."""
assert GenFlux is Genflux


def test_legacy_base_exception_aliases_preferred_base_exception() -> None:
"""Legacy base exception import remains an alias of the preferred name."""
assert GenFluxError is GenfluxError
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading