curl でのクイックスタート
最小限の動作する JSON モードリクエストは次のようになります。ベース URL https://api.uncensoredllmapi.com/v1、モデル uncensored、およびキーをベアラートークンとして使用します:
curl https://api.uncensoredllmapi.com/v1/chat/completions -H "Authorization: Bearer $UNCENSORED_API_KEY" -H "Content-Type: application/json" -d '{
"model": "uncensored",
"response_format": {"type": "json_object"},
"messages": [
{"role": "system", "content": "Reply only with a JSON object."},
{"role": "user", "content": "Create a tavern NPC with keys name, trade and rumour."}
]
}'
choices[0].message.content のアシスタントメッセージは、JSON オブジェクトを含む文字列です。自分で解析する必要があります。プロンプトの指示を省略しないでください。JSON モードは出力をオブジェクトに制限しますが、どのキーが必要かは推測できません。キーを指定し、できれば 1 行の例を示すことで、安定した形状が得られます。
まだキーをお持ちでない場合は、API キーページ でサインアップ後にワンクリックで $0.50 のトライアルクレジットが取得できます。このクレジットには支払いが必要なく、7 日間有効で、1 人あたり 1 回限りの制限があります。
検証付きの Python での JSON モード
モデルの出力を他の外部入力と同様に扱ってください。解析し、スキーマに対してチェックし、失敗した場合は限られた回数だけ再試行します。Pydantic を使用すると短く記述できます:
import json, os
from openai import OpenAI
from pydantic import BaseModel, ValidationError
client = OpenAI(
base_url="https://api.uncensoredllmapi.com/v1",
api_key=os.environ["UNCENSORED_API_KEY"],
)
class Npc(BaseModel):
name: str
trade: str
rumour: str
SYSTEM = (
"Reply only with a JSON object with exactly these keys: "
"name, trade, rumour. Each value is a string."
)
def make_npc(setting, tries=3):
for _ in range(tries):
r = client.chat.completions.create(
model="uncensored",
response_format={"type": "json_object"},
messages=[
{"role": "system", "content": SYSTEM},
{"role": "user", "content": f"Setting: {setting}"},
],
temperature=0.7,
max_tokens=300,
)
choice = r.choices[0]
if choice.finish_reason == "length":
continue # cut off, so the JSON is incomplete
try:
return Npc(**json.loads(choice.message.content))
except (json.JSONDecodeError, ValidationError, TypeError):
continue
raise RuntimeError("no valid JSON after retries")
print(make_npc("a river port in a plague year"))
そのスニペットの3つの習慣はコピーする価値があります。コードは解析前にfinish_reasonをチェックします。これは、max_tokensで停止した返信がオブジェクトの途中で終わる可能性があるためです。また、高い温度は不正な出力が発生する可能性が高くなるため、適度な温度を使用します。さらに、再試行数を制限することで、プロンプトが悪くても永遠にループしないようにします。失敗または拒否されたリクエストは課金されないため、再試行の予算はコストではなくレイテンシの問題です。
よくある JSON モードのミス
- プロンプトで JSON を要求しているが、
response_formatで指定していない。 モデルは従うことが多いですが、オブジェクトを文章やコードフェンスで囲むことがあります。両方を設定してください。 max_tokensを低く設定しすぎている。 最長の有効な回答を推定し、余裕を持たせてください。項目の長いリストは簡単に 300 トークンを超過します。- トップレベルの配列を期待している。 JSON モードはオブジェクトを要求します。リストが必要な場合は、
{"items": [...]}を要求してください。 - JSONに含まれるストップシーケンスを追加する。
stopパラメータは渡され、値に含まれるストップ文字列は返信を短く切り捨てます。 - ストリーミング時に JSON モードを使用し、各チャンクを解析している。 まず全文を収集し、最後に一度だけ解析してください。
temperature、top_p、seed、ペナルティなどのサンプリング設定は渡されます。抽出タスクの場合、温度を0.2程度に低くし、固定のseedを使用すると、最も再現性の高い出力が得られます。上記のNPCのようなクリエイティブな生成では、検証さえ行えば高い値でも問題ありません。
関数呼び出し:完全なループ
ツール呼び出しにより、モデルはコードに何かを実行させ、その結果を受けて続行できます。フローには4つのステップがあります:ツールを宣言する、モデルがtool_callsで返信する、それらを実行する、そしてrole: "tool"を持つメッセージとして結果を送信する。
import json, os
from openai import OpenAI
client = OpenAI(
base_url="https://api.uncensoredllmapi.com/v1",
api_key=os.environ["UNCENSORED_API_KEY"],
)
tools = [{
"type": "function",
"function": {
"name": "lookup_inventory",
"description": "Return the stock count for an item in the shop.",
"parameters": {
"type": "object",
"properties": {"item": {"type": "string"}},
"required": ["item"],
},
},
}]
def lookup_inventory(item):
stock = {"healing potion": 4, "rope": 12}
return {"item": item, "count": stock.get(item.lower(), 0)}
messages = [{"role": "user", "content": "Do you still have healing potions?"}]
for _ in range(4): # hard cap on tool rounds
r = client.chat.completions.create(
model="uncensored", messages=messages, tools=tools, tool_choice="auto"
)
msg = r.choices[0].message
if not msg.tool_calls:
print(msg.content)
break
messages.append(msg)
for call in msg.tool_calls:
args = json.loads(call.function.arguments)
result = lookup_inventory(**args)
messages.append({
"role": "tool",
"tool_call_id": call.id,
"content": json.dumps(result),
})
引数は JSON 文字列として届き、解析する必要があります。モデルはスキーマに一致しない引数を生成することがあります。副作用のある処理を実行する前に検証してください。チェックなしでシェル、SQL 文字列、またはファイルパスに渡さないでください。
tool_choice フィールドは動作を制御できます。"auto" のままにするとモデルが判断します。特定の関数名を指定すると呼び出しを強制でき、JSON モードではなくツールスキーマを通じて構造化された抽出を行いたい場合に便利です。
Node でのストリーミング関数呼び出し
stream: true の場合、関数呼び出しは断片として届きます。各チャンクには、位置ごとにインデックス付けされた関数名または引数文字列の断片が含まれます。インデックスごとに断片を連結し、ストリーミング終了時のみ解析する必要があります。
import OpenAI from "openai";
const client = new OpenAI({
baseURL: "https://api.uncensoredllmapi.com/v1",
apiKey: process.env.UNCENSORED_API_KEY,
});
const stream = await client.chat.completions.create({
model: "uncensored",
stream: true,
messages: [{ role: "user", content: "Check stock for rope." }],
tools: [{
type: "function",
function: {
name: "lookup_inventory",
description: "Return the stock count for an item.",
parameters: {
type: "object",
properties: { item: { type: "string" } },
required: ["item"],
},
},
}],
});
const calls = [];
for await (const chunk of stream) {
const delta = chunk.choices[0]?.delta;
for (const tc of delta?.tool_calls ?? []) {
const slot = (calls[tc.index] ??= { id: "", name: "", args: "" });
if (tc.id) slot.id = tc.id;
if (tc.function?.name) slot.name += tc.function.name;
if (tc.function?.arguments) slot.args += tc.function.arguments;
}
}
for (const c of calls) {
console.log(c.name, JSON.parse(c.args));
}
ストリーミングリクエストはストリーミング終了まで同時実行的なスロットの1つを保持することに注意してください。フルキーは8件の同時リクエストと1分あたり300件、トライアルキーは2件と60件を許可します。どちらかに到達すると、コードconcurrencyまたはrate_limitedを伴うHTTP 429が返ります。使用量はストリーミングの終了時に報告され、コストのログ記録に便利です。
JSON モードまたはツールスキーマ
両方とも構造化データを提供しますが、どちらを使用すべきでしょうか? 決定要因は、モデルがデータを生成しているのか、それともアクションを選択しているのかです。
出力自体が製品である場合に JSON モードを使用してください:NPC シート、タグのリスト、信頼度フィールド付きの分類など。プロンプト全体を制御し、1 つのオブジェクトが返され、課金されるリクエストは 1 つだけです。
モデルがアクションを実行するかどうかを判断する場合、または複数の異なるアクションが可能な場合にツールを使用してください。関数ごとのスキーマが契約を文書化し、tool_choice で呼び出しを強制または許可でき、前のセクションのループがマルチステップの作業を処理します。コストは、1ラウンドごとに1件の追加リクエストと、毎回入力としてカウントされるツール定義です。
抽出のための実用的な中間パス:必要なフィールドをパラメータとする 1 つのツールを宣言し、tool_choice をその関数に設定します。プロンプトにキーリストを書き込まずに、スキーマの形状に従う引数 JSON が得られます。いずれにせよ、結果を信頼する前に検証し、予期しないものを生成したリクエストの X-Request-Id 値をログに記録してください。
コスト
JSONとツール呼び出しは、他のトークンと同様に課金されます:入力1Mトークンあたり$0.15、出力1Mトークンあたり$0.50。ツール定義はすべてのリクエストで入力としてカウントされ、送信する各ツール結果は次のリクエストの入力に追加されます。
例:ツールを使用するアシスタントのターン。600 トークンのツールスキーマとプロンプト、150 トークンのモデル呼び出し、その後、900 入力トークン(以前のメッセージと関数結果を含む)と 200 トークンの返信を含む 2 番目のリクエスト。
- リクエスト 1:入力 600、出力 150。入力 600 x $0.15 / 1M = $0.00009。出力 150 x $0.50 / 1M = $0.000075。小計 $0.000165。
- リクエスト 2:入力 900、出力 200。入力 900 x $0.15 / 1M = $0.000135。出力 200 x $0.50 / 1M = $0.0001。小計 $0.000235。
- ターンの合計:$0.0004。
そのレートで1,000ターンは$0.40かかります。クレジットは$20から$500の整数金額で前払いされ、ボーナスとして$50以上で+5%、$100以上で+10%、$200以上で+15%が追加されます。USDT(TRC20)またはUSDC(Base)による暗号資産で支払いします。現在の料金は料金ページをご覧ください。
次のステップ
すべてのリクエストフィールドのリファレンスは API ドキュメント にあります。実トラフィック用のアプリケーションを準備している場合は、本番環境チェックリスト が次に読むべきページです。サポート はリクエストが予期しない動作をした場合に役立ちます。X-Request-Id ヘッダーで返されるリクエスト ID を手元に置いてください。
サービスはテキストのみで、コンテキストウィンドウは 100,000 トークンです(ツール定義と結果を含む)。未成年者を含む性的コンテンツは許可されておらず、これは構造化出力やツール駆動の出力にも、通常のチャットと同様に適用されます。
