Ollamaユーザー向けクイックスタート

前提条件

APIを使用するには、有効なAPIキーを持つアクティブなアカウントが必要です。GoogleまたはメールアドレスとパスワードでAPIキーの取得ページに登録してください。電話番号は不要です。また、マシンにサポート対象の言語SDKがインストールされている必要があります。本ガイドでは、OpenAI互換エンドポイントの主要なクライアントであるPythonとNode.jsを取り扱います。APIは単一の無検閲モデル（uncensored）を提供します。テキストを入力として受け取り、テキストを返します。埋め込み、画像、音声機能はありません。すべてのリクエストはhttps://api.ollamaapi.cc/v1に送信されます。

SDKのインストール

希望する言語の公式SDKをインストールしてください。Pythonの場合はpipを、Node.jsの場合はnpmを使用します。これらのライブラリはHTTPプロトコル、JSONシリアライズ、ストリーミングを自動的に処理します。制御を細かく行いたい場合を除き、生のHTTPリクエストを書く必要はありません。SDKは十分に文書化されており、本番環境で広く使用されています。環境がSDKの要件と一致していることを確認してください。Python 3.8以上とNode.js 18以上を推奨します。新しいモデルパラメータとの互換性問題を避けるため、依存関係を最新に保ってください。

クライアントの設定

ベースURLを当社のエンドポイントに設定してください。これだけでOpenAIから当社の無検閲サービスに切り替えることができます。API キーは認証ヘッダーとして渡してください。SDKがその後の処理を行います。モデル名をgpt-4やそれに類似する名前に変更しないでください。代わりにuncensoredを使用してください。APIはOpenAIのchat-completionsプロトコルを厳格に準拠しています。OpenAIで動作するクライアントは、この2つの変更を行うだけでここで動作します。これにより、マイグレーションやA/Bテストが容易になります。両方のAPIを並行して実行して出力を比較することもできます。

最初のリクエストの送信

/v1/chat/completionsにPOSTリクエストを送信します。モデルID、システムプロンプト、ユーザーメッセージを含めてください。APIはテキストレスポンスを返します。クレジットがあればリクエストは成功します。クレジットが不足している場合は402エラー、キーが無効な場合は401エラーが発生します。これらのエラーは標準的であり、コードで容易に処理できます。モデルは合法的な成人向けコンテンツを拒否しないため、クリエイティブライティング、セキュリティ調査、無検閲チャットに役立ちます。残りのクレジットが不明な場合はダッシュボードで残高を確認してください。

ストリーミングレスポンス

stream: trueを設定してストリーミングを有効にします。APIはトークンが生成されるたびに返します。これにより、ユーザーの体感レイテンシが削減されます。最後のチャンクには課金用の総トークン使用量が含まれます。ストリーミングはすべての公式SDKでサポートされています。テキストが書き込まれる様子を表示したいチャットインターフェースでは必須です。サーバーはServer-Sent Events（SSE）を送信します。クライアントライブラリが解析を処理します。カスタムクライアントを構築する場合を除き、イベントストリームの管理を手動で行う必要はありません。

制限、エラー、コンテキスト

コンテキストウィンドウは合計で100,000トークン、最大出力は32,000トークンです。リクエストは1分あたり300件、キーあたり8つの同時リクエストに制限されています。リクエストボディは8 MB以下である必要があります。エラーには、無効なキーの場合の401、クレジット不足の場合の402、レート制限の場合の429が含まれます。これらは標準的なHTTPステータスコードです。アプリケーションで適切に処理してください。モデルは未成年者を含む性的なコンテンツをブロックします。その他のコンテンツはすべて許可されます。クレジットは期限切れにならないため、利用を一時停止しても資金が失われることはありません。返金に関する問題についてはサポートページまでご連絡ください。

cURL

Copycurl https://api.ollamaapi.cc/v1/chat/completions \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "uncensored",
    "messages": [{"role": "user", "content": "Write a blunt product review of a cheap VPN."}]
  }'

Python

Copyfrom openai import OpenAI

client = OpenAI(base_url="https://api.ollamaapi.cc/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)

Node.js

Copyimport OpenAI from "openai";

const client = new OpenAI({ baseURL: "https://api.ollamaapi.cc/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);

ストリーミング

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)