メインコンテンツまでスキップ

NovelAI Python SDK

intro

PyPI version Python Version License Code style: ruff

NovelAIの画像生成APIのための、モダンで型安全なPython SDKです。 Pydantic v2による堅牢なバリデーションと完全な型ヒントを備え、開発者体験(DX)を重視して設計されています。

主な機能

  • 完全な型安全性: Python 3.10+対応、Pydantic v2による厳格なバリデーション。
  • 高レベルAPI: 直感的で使いやすいインターフェース。
  • 最新機能への対応: V4モデル、精密参照(キャラクター参照)、ControlNetなどをサポート。
  • 便利なユーティリティ: PIL/Pillow統合、SSEストリーミングなど。

他ライブラリとの比較

機能novelai-sdknovelai-apinovelai-python
型安全 (Pydantic v2)
非同期サポート
画像生成
テキスト生成🚧
精密参照(キャラクター参照)
マルチキャラクター配置
ControlNet / Vibe Transfer
SSE ストリーミング
Python 3.10+
アクティブメンテナンス⚠️

✅ 対応 | ❌ 未対応 | 🚧 予定 | ⚠️ 限定的なメンテナンス

データモデル・アーキテクチャ

このライブラリは、2つの異なるデータモデル層で設計されています:

モデルアーキテクチャ

  1. User Model(推奨): 適切なデフォルト値と自動バリデーションを備えた、ユーザーフレンドリーなモデル。
  2. API Model: NovelAIのAPIエンドポイントと1対1で対応する、主に内部で使用されるモデル。

どこから始めますか?

  • はじめに: インストールから最初の画像生成まで。
  • 認証: APIキーの設定方法。
  • 機能例: 実践的な使用例。

リンク

免責事項

これは非公式のクライアントライブラリです。NovelAIとは提携していません。 利用には有効なNovelAIサブスクリプションが必要です。