アンセンサードチャット補完向けAPIドキュメント

クイックスタート: Python または JavaScript で接続

ベースURLを更新し、APIキーを設定してAPIに接続します。エンドポイントは標準的なchat-completionリクエストを受け取り、テキストを返します。インターフェースが仕様に完全に一致しているため、公式のOpenAI SDKを使用している場合はカスタムライブラリのインストールは不要です。

接続を確認するために簡単なHTTPリクエストから始めます。以下のcurlコマンドを使用して、基本的なプロンプトを送信してください。 uncensored モデルです。 YOUR_API_KEY ダッシュボードで生成されたキーを使用してください。

Copycurl https://api.aiplayrolebest.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Set the character persona to a grumpy detective"}]
  }'

Python開発者にとって、プロセスはほぼ同じです。キーと正しいベースURLを使用してクライアントを初期化します。これにより、既存のツールチェーンとの互換性を維持しながら、すべてのリクエストが当社のフィルターなしサーバーにルーティングされます。

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.aiplayrolebest.com/v1", api_key="YOUR_KEY")

resp = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Summarise this thread without softening it."}],
)
print(resp.choices[0].message.content)

JavaScriptユーザーはNode SDKを使用して同じ結果を達成できます。 baseURL プロパティをエンドポイントに設定します。このアプローチにより、最小限のコード変更で API を Web サーバーやバックエンドサービスに統合できます。

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.aiplayrolebest.com/v1", apiKey: process.env.API_KEY });

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Draft a villain monologue for my game." }],
});
console.log(resp.choices[0].message.content);

認証とAPIキーの管理

認証はヘッダーに渡される単一のAPIキーに依存します。このキーをヘッダーに渡してください Authorization すべてのリクエストで必要です。キーが不足しているか無効な場合、APIは直ちに401エラーを返します。これにより、プリペイド残高への安全なアクセスが保証されます。

ダッシュボードでキーを生成します。キーは作成時に1回だけ表示されます。環境変数に安全に保存してください。公開共有しないでください。各アカウントでは同時に1つのアクティブなキーのみがサポートされます。新しいキーを生成すると、以前のキーは即時に無効になります。

リクエストでキーを以下のように使用します: Authorization: Bearer YOUR_API_KEYこの標準的なヘッダー形式は主要なSDKすべてと連携します。開発中の迅速な反復のためにキーをすぐ使える状態に保ってください。

チャット完了エンドポイントのパラメータ

にリクエストを送信します /v1/chat/completions エンドポイント。メッセージの配列を含め、モデルを uncensored。 temperature および top_p 創造性を制御する。高い値はより多様な応答を生成します。

設定 max_tokens 出力長を制限します。未指定の場合のデフォルトは2,048トークンです。モデルはプロンプトと補完を合わせて100,000トークンのコンテキストウィンドをサポートします。これにより、切り捨てなしで長い会話が可能です。 presence_penalty および frequency_penalty ロールプレイシナリオでの反復を減らします。

を使用 stop 特定のフレーズで生成を停止させるためのパラメータ。これによりダイアログ構造が強制されます。 seed パラメータはテスト用の再現可能な出力を保証します。これらのツールにより、モデルの動作を精密に制御できます。

ストリーミングレスポンスと使用データ

streamをtrueに設定してストリーミングを有効にする stream: true リクエスト内。APIは生成されるたびにテキストチャンクを返します。これにより、エンドユーザーに対する知覚遅延が軽減されます。各チャンクには部分的なテキストとメタデータが含まれます。

使用データは最終チャンクに表示されます。これには入力および出力のトークン数が含まれます。確認してください。 usage 最後のレスポンスオブジェクト内のフィールド。これにより、別のAPI呼び出しなしで正確な請求検証が可能です。トークン消費をリアルタイムで追跡します。

接続を閉じる前にすべてのチャンクを処理していることを確認してください。最後のチャンクには完全な使用量統計が含まれています。このデータは、本番環境でのコストとパフォーマンスの監視に不可欠です。

Copystream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Tell the story in second person."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)

エラー処理とレート制限

APIはキーあたり1分あたり300リクエストの制限を適用します。キーあたりの同時リクエストは8つまでです。リクエストボディは8 MBを超えてはなりません。これらの制限を超えると429エラーが発生します。一時的なスパイクを処理するために指数関数的バックオフを実装してください。

よくあるエラーには、無効なキーによる401とクレジット不足による402が含まれます。402レスポンスはプリペイド残高が枯渇したことを示します。サービスを再開するにはアカウントにチャージしてください。エラーはトークンを消費しないため、問題を修正後に再試行しても無料です。

レスポンスボディに詳細なエラーメッセージが含まれているか確認してください。APIはエラータイプとメッセージを含むJSONオブジェクトを返します。この情報を使用して、問題を迅速にデバッグしてください。適切なエラーハンドリングにより、トラフィックの多い期間でもユーザーにスムーズな体験を提供できます。

JSONモードと関数呼び出しガイド

JSONモードを response_format に {"type": "json_object"}これはモデルに有効なJSONを出力させることを強制します。構造化データの抽出やAPIレスポンスに最適です。プロンプトで希望するスキーマを明確に記述してください。

関数呼び出しにより、モデルはツールを呼び出すことができます。リクエスト本文でツールを定義します。モデルは適切な場合にツール呼び出しを返します。これらの呼び出しをアプリケーションロジックで処理します。これにより、複雑なマルチステップワークフローが可能になります。

JSONモードを関数呼び出しと組み合わせることで、堅牢な統合が可能です。クライアント側でJSON出力を検証します。 tool_choice 関数の呼び出しタイミングを制御するパラメータ。この柔軟性は多様なアプリケーションアーキテクチャをサポートします。最適なパフォーマンスを得るためにツールを明確に定義してください。

モデルの詳細とコンテキストウィンドウの制限

The uncensored モデルは100,000トークンのコンテキストウィンドウをサポートしています。これには入力プロンプトと出力補完の両方が含まれます。1リクエストあたりの最大出力は16,000トークンです。これにより、文の途中で途切れることなく、広範なロールプレイシナリオが可能になります。

このモデルはオープンウェイトであり、制限のないコンテンツ向けにチューニングされています。法的な成人向けトピックを拒否しません。GPT、Claude、または他のどのベンダーモデルでもありません。リクエストは専用サーバーで処理されます。これにより、一貫したパフォーマンスと低レイテンシが保証されます。

コンテキストの使用量を監視して制限内に収めます。APIはトークン使用量を正確に追跡します。エラーや拒否はトークンを消費しません。この透明性のある課金モデルにより、コストを予測しやすくなります。コンテキストウィンドウを計画して価値を最大化しましょう。