実行する前に
キーのみで十分です。API キーページでキーを作成してください。新規アカウントはカード登録なしでワンクリックで無料トライアルクレジット $0.50 を取得できます。エクスポートして、例で読み込めるようにしてください。
export API_KEY="YOUR_KEY"
pip install openai
npm install openai
APIはOpenAIのchat completions形式に従います。POST /v1/chat/completions と GET /v1/models を公開し、Authorization: Bearer を受け付け、ID uncensored の単一モデルを提供します。このモデルは独立したプロバイダが運用するオープンウェイトモデルで、合合合法的な成人向け利用においてコンテンツ拒否なしで回答するように調整されています。いかなるモデルベンダーの公式APIではありません。テキストのみを処理し、画像、音声、埋め込み、ファインチューニングはサポートしません。
以下の例は、最も簡単な呼び出しから関数呼び出しまでを扱います。キーが機能するかどうかを確認するための最短チェックだけでよい場合は、最初の curl コマンドだけで十分です。
curl による最初のリクエストと、重要なパラメータ
curl https://api.glmapikey.com/v1/chat/completions \
-H "Authorization: Bearer $API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "uncensored",
"messages": [
{"role": "system", "content": "You are a concise assistant."},
{"role": "user", "content": "What is a mutex, in one sentence?"}
],
"temperature": 0.3,
"max_tokens": 80
}'
応答は JSON オブジェクトで、choices[0].message.content に回答が含まれ、usage オブジェクトには prompt_tokens と completion_tokens が含まれます。応答ヘッダーには X-Request-Id、X-Balance-USD と 2 つの X-RateLimit-Limit ヘッダーが含まれます。curl に -i を追加して表示します。
フィールド temperature、top_p、stop、seed およびpresence・frequency ペナルティはモデルに渡されます。max_tokens はオプションです。指定しない場合、完了生成はプロンプトの後に残る 100,000 トークンのウィンドウをすべて使用する可能性があります。
chat completions のボディには多くのオプションフィールドがありますが、5 つが主要な役割を果たします。これらすべてがモデルに渡されます。
| フィールド | 機能 | 一般的な用途 |
|---|---|---|
temperature | 高い値はより多様な表現を生成します。 | 抽出には 0.2、フィクションには 0.8 |
top_p | サンプリングを最も可能性の高いトークンに制限します | 調整しない限りデフォルトのままにします |
stop | 文字列が出現すると応答を終了します。 | 空白行などの区切り文字で切り捨てます |
seed | ベストエフォートベースでサンプリングを再現可能にします | 2 つのプロンプトバージョンを比較する場合 |
presence_penalty、frequency_penalty | トークンの繰り返しを抑制します | テキストがループする場合、0.3 などの小さな値 |
一度に 1 つの値だけ変更し、プロンプトは同じままにしてください。そうしないと、どの変更が役立ったのかがわかりません。分類や抽出などコードを生成する用途では、低い温度と固定シードを使用してテストを再実行しても同じ結果が得られるようにしてください。クリエイティブな文章生成では、温度を上げてペナルティで反復を制御します。
ここで max_tokens フィールドはオプションです。省略すると、応答は 100,000 トークンのウィンドウに残っているすべてのスペースを使用する可能性があり、1 行の回答には通常望ましくありません。回答の長さがわかっている場合は設定してください。
Python:メモリ付きの会話
API はステートレスなので、会話履歴は自分で保持し、毎回送信する必要があります。このループはメッセージのリストを保持し、両者のメッセージを追加します。
from openai import OpenAI
client = OpenAI(
base_url="https://api.glmapikey.com/v1",
api_key="YOUR_KEY",
)
messages = [{"role": "system", "content": "You are a helpful assistant."}]
while True:
user = input("you> ")
if not user:
break
messages.append({"role": "user", "content": user})
resp = client.chat.completions.create(model="uncensored", messages=messages)
reply = resp.choices[0].message.content
messages.append({"role": "assistant", "content": reply})
print("bot>", reply)
各呼び出しで完全なリストが再送信されるため、入力トークンはチャットの長さとともに増えます。1M トークンあたり $0.15 という価格ですが、長時間のセッションでは累積するため、スレッドが課金対象にしたいサイズを超えたら古いメッセージを削除してください。料金ページには実例が記載されています。
Python と Node でのストリーミング
stream: trueを設定すると、サーバーはトークンを生成次第、サーバー送信イベント(SSE)で送信します。Pythonでは:
stream = client.chat.completions.create(
model="uncensored",
messages=[{"role": "user", "content": "Write four lines about the sea."}],
stream=True,
)
text = ""
for chunk in stream:
if chunk.choices and chunk.choices[0].delta.content:
piece = chunk.choices[0].delta.content
text += piece
print(piece, end="", flush=True)
if getattr(chunk, "usage", None):
print("\ntokens:", chunk.usage.prompt_tokens, chunk.usage.completion_tokens)
ストリームは使用情報で終了するため、ループで確認します。Node では同じこと:
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api.glmapikey.com/v1",
apiKey: process.env.API_KEY,
});
const stream = await client.chat.completions.create({
model: "uncensored",
messages: [{ role: "user", content: "Write four lines about the sea." }],
stream: true,
});
for await (const chunk of stream) {
process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}
制限に関する 1 つの注意点:ストリーミングリクエストはストリームが終了するまで同時実行数のスロットを保持します。ストリームを開始して最後まで読み取らない場合、そのスロットはビジー状態のままになります。常にストリームを消費または閉じてください。
構造化出力のためのJSON モード
コードで回答を解析する必要がある場合は、response_formatでJSONオブジェクトをリクエストしてください。また、プロンプトで望む形式を指定してください。フォーマットフラグは特定のスキーマではなく、有効なJSON構文を保証するからです。
import json
resp = client.chat.completions.create(
model="uncensored",
response_format={"type": "json_object"},
messages=[
{"role": "system", "content": "Reply only with JSON: {\"title\": string, \"tags\": [string]}."},
{"role": "user", "content": "Suggest a title and three tags for a post about home espresso."},
],
temperature=0.2,
)
data = json.loads(resp.choices[0].message.content)
print(data["title"], data["tags"])
使用する前に必要なキーが存在するか確認し、抽出作業には温度を低く保ってください。解析に失敗した場合、同じ入力で再試行すると通常成功し、失敗したリクエストは課金されません。
ツール呼び出し:完全な往復
ツール呼び出し機能により、モデルはコードに関数を実行するよう依頼できます。関数をtoolsで記述し、モデルはtool_callsエントリで返信します。それを実行し、結果をrole: "tool"メッセージとして送信します。
import json
def get_weather(city: str) -> dict:
return {"city": city, "temp_c": 18, "sky": "cloudy"}
tools = [{
"type": "function",
"function": {
"name": "get_weather",
"description": "Get current weather for a city",
"parameters": {
"type": "object",
"properties": {"city": {"type": "string"}},
"required": ["city"],
},
},
}]
messages = [{"role": "user", "content": "Is it warm in Lisbon right now?"}]
first = client.chat.completions.create(
model="uncensored", messages=messages, tools=tools, tool_choice="auto"
)
msg = first.choices[0].message
if msg.tool_calls:
messages.append(msg)
for call in msg.tool_calls:
args = json.loads(call.function.arguments)
messages.append({
"role": "tool",
"tool_call_id": call.id,
"content": json.dumps(get_weather(**args)),
})
final = client.chat.completions.create(
model="uncensored", messages=messages, tools=tools
)
print(final.choices[0].message.content)
else:
print(msg.content)
ここでの関数は固定データを返すため、実際の検索処理に置き換えてください。ツール引数は JSON 文字列として渡されるため、それに基づいて処理を実行する前に必ず解析して値を検証してください。stream: true の場合、tool_calls は分割して届くため、解析する前に組み立ててください。特定のツールを強制する必要がある場合は tool_choice を使用してください。
例のコストと 1 時間を無駄にするミス
例の実行には非常に少ないコストで済みますが、計算を一度確認すると役立ちます。1M 入力トークンあたり $0.15、1M 出力トークンあたり $0.50 で:
- 会話ループ、1,200 トークンのプロンプトと 300 トークンの応答の場合:入力は $0.00018、出力は $0.00015 で合計 $0.00033 です。1,000 ターンで $0.33 かかります。
- ツール往復 は 2 回の呼び出しを行います。1 回目が 400 トークン入力、60 出力、2 回目が 500 入力、150 出力の場合、合計は 900 入力、210 出力で:$0.000135 + $0.000105 = $0.00024 です。
- ストリーミング は、同じトークン数の通常呼び出しと同じコストがかかります。テキストの表示されるタイミングが変わるだけで、コストは変わりません。
無料トライアルクレジットの $0.50 は、そのサイズで会話ループの 1,500 ターン分以上を支払うのに十分です($0.50 / $0.00033)。チャージする前に自由に実験できます。失敗したリクエストや拒否されたリクエストは課金対象外なので、解析のバグで呼び出しを再実行しても、失敗した試行に対してコストはかかりません。
- 間違った Base URL。
/v1で終わる必要があります。SDK の Base URL に/chat/completionsを手動で追加すると、SDK がパスを追加するため 404 になります。 - 異なるモデル名。 他のプラットフォームからコピーした名前は存在しません。ID は
uncensoredです。 - メモリを期待すること。 API は以前の呼び出しを記憶しません。履歴を毎回送信してください。
- ガードなしでモデルのJSONを解析する。
json.loadsをtryブロックで囲み、失敗時の計画を立ててください。 - ストリームを開きっぱなしにする。 完了していないストリームは同時実行数のスロットを占有し、トライアルキーには2つしかありません。
- キーをフロントエンドコードに配置する。 サーバーに保持してください。
まだ問題がある場合は、curlでリクエストを送信し、コードが生成する内容と比較してください。curlでの送信はSDKの影響を排除し、ボディの相違を明確にします。
使用量、残高、エラーの確認
Python SDKからのレスポンスヘッダーを確認するには、生のレスポンスラッパーを使用します:
raw = client.chat.completions.with_raw_response.create(
model="uncensored",
messages=[{"role": "user", "content": "Say ok."}],
)
print("request id:", raw.headers.get("x-request-id"))
print("balance usd:", raw.headers.get("x-balance-usd"))
print("rpm limit:", raw.headers.get("x-ratelimit-limit-requests"))
completion = raw.parse()
print(completion.usage.total_tokens)
すべての呼び出しにリクエストIDをログに記録し、後で特定のリクエストを指し示せるようにしてください。残高ヘッダーを使用して、クレジットが尽きる前にアラートを発生させてください。
制限を超えると、APIはHTTP 429を返し、エラーコードがどの制限に該当するかを示します:
| コードまたはヘッダー | 対処 | 対処 |
|---|---|---|
rate_limited | 1分あたりのリクエスト数が多すぎます(フルキーは300、トライアルは60) | バックオフし、呼び出しを分散させる |
concurrency | 一度に多すぎます(フルキーは8、トライアルは2) | 実行中のリクエストが完了するまで待つ |
Retry-After: 5 | 一時的な過負荷 | 5秒後に再試行する |
失敗したリクエストと拒否されたリクエストは課金されません。リクエストボディは最大8 MBまで可能です。完全なリファレンスと既存のクライアントコードの再利用方法については、ドキュメントをご覧ください。APIキーの取得方法については、GLM APIキーの記事をご覧ください。
