JA ▾

GPT API base_url:任意のOpenAI互換クライアントでの設定方法

base URLは、OpenAIスタイルのクライアントがどのサーバーと通信するかを決定する唯一の設定です。これを変更し、キーとモデル名を変更すれば、残りのコードはそのまま維持されます。

更新

あるサーバーから別のサーバーへデータパケットを振り向ける道標。base URLの変更を表している

主要ポイント

  • 当社のbase URLはhttps://api.uncensoredgptapi.com/v1であり、モデルIDはuncensoredです。
  • PythonとNode SDKはbase_urlまたはbaseURLを受け取ります。どちらも環境変数も読み取ります。
  • 失敗のほとんどは、/v1の欠落、パスの二重化、または古いモデル名に起因します。
  • GET /v1/modelsは、URLとキーが正しいことを確認する最も迅速な方法です。

base URLの役割

gpt api base_url は、OpenAI SDK がすべてのエンドポイントパスに前置するアドレスです。デフォルトでは、公式 SDK は OpenAI のサーバーにリクエストを送信します。別のベースURLを設定すると、同じクライアントコードが同じリクエスト形式を、同じプロトコルに従う別のサーバーに送信します。

これが実用上のOpenAI互換の意味です。当社のAPIは、同じJSON構造、同じAuthorization: Bearerヘッダー、および同じストリーミング形式で、POST /v1/chat/completionsとGET /v1/modelsを受け入れます。したがって、次の3つの値を変更します。

  • Base URL: https://api.uncensoredgptapi.com/v1
  • APIキー: ダッシュボードのキー
  • モデル: uncensored

当社のサービスは、単一のオープンウェイトモデルを実行する独立したサービスです。OpenAIのAPIではなく、他社ベンダーへのルーターでもありません。そのため、gpt-4oなどのモデル名はここでは存在しません。すべての箇所でuncensoredを使用してください。

OpenAI SDKを使用したPython

現在のPython SDKでは、クライアント作成時にbase_urlを渡します。

from openai import OpenAI

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

resp = client.chat.completions.create(
    model="uncensored",
    messages=[
        {"role": "system", "content": "You are a concise assistant."},
        {"role": "user", "content": "Explain what a base URL is in two sentences."},
    ],
)
print(resp.choices[0].message.content)

コードが古く、openai.api_base を使用している場合、それはグローバル設定の名前が異なる v1.0 未満の SDK です。パッケージのアップグレードは、コードを修正するよりも通常は簡単です。pip show openai でバージョンを確認してください。

SDKがリクエストを構築する方法を知っておくと役立ちます。SDKはあなたのbase URLを取り、/chat/completionsなどのエンドポイントパスを追加し、あなたのキーからのAuthorization: Bearerヘッダーを追加します。これこそが全体のメカニズムです。何か失敗した場合は、最終URLを出力またはログに記録し、次のセクションのcurlコマンドと比較してください。

同じクライアントはtimeoutとmax_retries設定を受け入れます。デフォルトは接続の問題が発生した場合に数回再試行するため、ほとんどのスクリプトには問題ありません。レート制限の場合、SDKのレート制限例外をキャッチしてバックオフしてください。ストリーミングリクエストは終了するまで並行スロットを保持するため、長時間のストリーミングのバーストは、1分あたりのリクエスト数が少なくても、並行制限に達する可能性があります。

import time
from openai import OpenAI, RateLimitError

client = OpenAI(base_url="https://api.uncensoredgptapi.com/v1", api_key="YOUR_API_KEY", max_retries=0)

def ask(text, tries=4):
    for attempt in range(tries):
        try:
            r = client.chat.completions.create(
                model="uncensored",
                messages=[{"role": "user", "content": text}],
            )
            return r.choices[0].message.content
        except RateLimitError:
            time.sleep(5 * (attempt + 1))
    raise RuntimeError("still rate limited")

最初の再試行時の5秒の待機は、一時的な過負荷時にAPIが送信するRetry-After: 5の値と一致します。後の試行ではより長く待機することで、エンドポイントへの過剰なアクセスを避けます。

Nodeとcurl

Node SDK は、大文字の URL を持つ baseURL を使用します。

import OpenAI from "openai";

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

const resp = await client.chat.completions.create({
  model: "uncensored",
  messages: [{ role: "user", content: "Name three uses for a base URL." }],
});
console.log(resp.choices[0].message.content);

SDK なしで curl を使用すると、SDK が何をしているのかが正確にわかります。完全な URL は、ベースURL に /chat/completions を加えたものです。

curl https://api.uncensoredgptapi.com/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model":"uncensored","messages":[{"role":"user","content":"ping"}]}'

そのコマンドを読むことは、ベースURL を理解する最も明確な方法です。/v1 までを含むすべての部分がベースであり、SDK が残りの部分を付け加えます。

環境変数

コードを編集できない場合、または複数のスクリプトに1つの設定を使用したい場合は、明示的な値が指定されていない場合に、OpenAI SDK は環境変数から OPENAI_BASE_URL と OPENAI_API_KEY を読み取ります。

export OPENAI_BASE_URL="https://api.uncensoredgptapi.com/v1"
export OPENAI_API_KEY="YOUR_API_KEY"
python my_script.py

これはあなたが作成していないツールに便利です。OpenAI SDKに基づいて構築されたものは、変更なしで変数を読み取る場合がありますが、ツール内でモデル名をuncensoredに設定する必要があります。ツールがモデルをハードコードしている場合、独自の設定またはコードの変更が必要です。

2つのエンドポイントを分離する

多くのプロジェクトは、1つのエンドポイントでテストし、別のエンドポイントでリリースするか、環境によって切り替えます。3つの値をコードから除外し、設定から読み取るようにしてください。そうすれば、切り替えはファイルの変更になり、コードの編集にはなりません。

import os
from openai import OpenAI

client = OpenAI(
    base_url=os.environ.get("LLM_BASE_URL", "https://api.uncensoredgptapi.com/v1"),
    api_key=os.environ["LLM_API_KEY"],
)
MODEL = os.environ.get("LLM_MODEL", "uncensored")

SDK のデフォルトではなく独自の変数名を使用すると、目立たない罠を避けることができます。シェルから OPENAI_API_KEY を読み取るツールは、そこに設定されているキーを、隣に設定されているベースURL に送信します。プロフィールに古い OpenAI キーがあり、プロジェクトに新しいベースURL がある場合、あるサービスのキーを別のサービスに送信してしまう可能性があります。異なる名前を使用すれば、そのようにはならず、スクリプトがどのエンドポイントを使用するか一目でわかります。

モデル名も設定として扱ってください。これは切り替え時に最もよく残される値であり、他のすべてが正しく見えるため、最も混乱を招く失敗を引き起こします。

ストリーミングとツールは同じベースURL を使用します

base URLの変更は機能を制限しません。ストリーミング、ツール呼び出し、JSON モードはすべて同じ/chat/completionsパスを経由するため、元のAPIに対して機能していたコードは引き続き機能します。ストリーミングはServer-Sent Eventsを返し、使用状況はストリームの最後に報告されます。

from openai import OpenAI

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

stream = client.chat.completions.create(
    model="uncensored",
    messages=[{"role": "user", "content": "Count from one to five."}],
    stream=True,
)
for chunk in stream:
    if chunk.choices and chunk.choices[0].delta.content:
        print(chunk.choices[0].delta.content, end="", flush=True)
print()

chunk.choices のガードが重要です。使用量を含む最後のチャンクには choices が含まれていない場合があり、空のリストにインデックスを付けるコードは最後のメッセージでクラッシュします。ツール呼び出しも同じ方法でストリーミングされ、関数を実行する前に組み立てられる部分的な tool_calls 増分としてストリーミングされ、結果は role: "tool" を持つメッセージとして返されます。JSON モードでは response_format={"type": "json_object"} を使用します。

base URLフィールドを持つアプリとフレームワーク

多くのアプリは、異なる名前で同じ設定を公開しています:API ベース、エンドポイント、カスタム OpenAI URL、またはホスト。ルールは変わりません。ベースURL に /v1 を含めて貼り付け、キーを貼り付け、モデル名として uncensored と入力します。

例えば SillyTavern は、OpenAI 互換のエンドポイントを追加できます。LangChain の ChatOpenAI クラスは base_url 引数を受け入れます。他のフロントエンドは、そのフィールドをプロキシ URL またはリバースプロキシと呼びます。フィールド名はバージョンによって異なるため、/v1 で終わる URL を受け取るものを探してください。

いくつかのアプリは、GET /v1/modelsを呼び出して埋めるドロップダウンからモデルを要求します。このエンドポイントはここで機能し、モデルリストを返すため、URLとキーが正しい場合、ドロップダウンにはuncensoredが表示されるはずです。空のままの場合、URLまたはキーが間違っています。

アプリがベースURL フィールドと「organization」または「project」フィールドの両方を提供する場合、余分なフィールドは空のままにしてください。これらは元のサービスのために存在するもので、ここでは意味を持ちません。アプリが特定のプレフィックスで始まるキーを必要とする場合、元のサービスのプリセットではなく、汎用またはカスタム OpenAI 互換オプションなどの異なる接続タイプを試してください。

一部のデスクトップツールは、元のプロバイダから特定のモデル名をリクエストして接続をテストし、エンドポイントが正常でも失敗を報告します。その場合、テストボタンをスキップして、実際のメッセージを送信してください。返信が届く場合、URL、キー、モデルは正しく、ツールはチェックが厳しすぎるだけです。

ブラウザベースのツールもクロスオリジンのルールに直面する可能性があります。リクエストがページから別のホストに移動するためです。ブラウザでウェブツールが失敗し、同じ呼び出しがcurlで機能する場合、小さなサーバーからリクエストを実行してください。そうすれば、キーはクライアント側のコードから離れ、いずれにせよより安全な設計になります。

よくあるミスとその修正法

失敗したセットアップのほとんどは、短いリストに起因します。

  • /v1の欠落。 base URLはhttps://api.uncensoredgptapi.com/v1であり、ホスト名だけでなく、/v1までの完全なアドレスです。/v1がないと、SDKは存在しないパスを構築します。
  • パスの二重化。 base URLとして.../v1/chat/completionsを貼り付けると、SDKはパスを再度追加します。baseのみを提供してください。
  • 末尾のスラッシュ。 ほとんどの SDK はこれを処理しますが、一部のツールは処理しません。末尾にスラッシュを付けずに試してください。
  • 古いモデル名。 元のコードから残ったgpt-4oなどのモデル名は一致しません。uncensoredを設定してください。
  • 間違ったキー。 このサービスのキーを使用してください。OpenAIのキーはここでは機能せず、当社のキーはOpenAIでは機能しません。
  • レート制限エラー。 コード rate_limited の HTTP 429 は、1分あたりのリクエストが多すぎることを意味します。コード concurrency は、一度に多すぎることを意味します。Retry-After: 5 ヘッダーを持つ 429 は一時的な過負荷を示すため、5秒待ってから再試行してください。

トラブルシューティングガイドでは、統合エラーについてより詳しく解説しています。

1回の呼び出しでセットアップを確認

アプリケーション全体を実行する前に、モデルのエンドポイントを呼び出してください。これは低コストで、URLとAPIキーの両方が正しく設定されていることを確認できます。

curl https://api.uncensoredgptapi.com/v1/models \
  -H "Authorization: Bearer $API_KEY"

uncensoredを含むリストが返された場合は、実際のチャットリクエストを送信してください。完全なAPIキーの場合、最大8つの同時リクエストと1分あたり300リクエストが可能です。試用版のAPIキーでは、同時2リクエスト、1分あたり60リクエストが許可されます。各レスポンスにはX-Request-Id、X-Balance-USD、およびレート制限ヘッダーが含まれており、デバッグに役立ちます。

APIキーを取得するには、登録してAPIキーページを使用してください。新規ユーザーはワンクリックで$0.50の無料トライアルクレジットを取得できます。接続が完了したら、ドキュメントでストリーミング、ツール呼び出し、JSONモードについて確認できます。

質問と回答

APIのベースURLは何ですか?

https://api.uncensoredgptapi.com/v1 です。/v1 の部分を含め、エンドポイントパスは含めないでください。

どのモデル名を使用すればよいですか?

uncensoredを使用してください。gpt-4oなどの他のプロバイダーのモデル名は、ここでは利用できません。

既存のOpenAI SDKコードを使用できますか?

はい。ベースURL、APIキー、モデル名を変更してください。チャット補完(chat completions)、ストリーミング、ツール呼び出し、JSONモードはすべて同じリクエスト形式に従います。

OPENAI_BASE_URL変数は機能しますか?

公式のOpenAI SDKは、コードにベースURLが渡されない場合にそれを読み取ります。そのため、設定するだけで十分な場合が多いです。使用するツールを確認してください。一部のツールは無視することがあります。

なぜ429エラーが発生するのですか?

rate_limitedというコードは1分あたりのリクエストが多すぎること、concurrencyというコードは一度に多すぎることを示します。Retry-Afterが5の429エラーは一時的な過負荷を意味するため、5秒後に再試行してください。

キーはフォーム 1 つで手に入ります

アカウントを作成し、キーをコピーし、ベースURLを変更します。これでセットアップは完了です。

API キーを取得