Ollama APIクイックスタートガイド

ベースURLと認証設定

クライアントを当社のホストエンドポイントに設定してください。 base_url に https://api.apiollama.com/v1 キーを Authorization ヘッダー。認証は標準的な Bearer スキーム。ダッシュボードでGoogleまたはメールを使用してキーを生成できます。システムはアカウントごとに1つのアクティブなキーを作成します。

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

キーは安全に保管してください。新しいキーが必要な場合は、ダッシュボードで生成してください。古いキーは即座に非アクティブになります。セットアップに電話番号は不要です。このセットアップは、あらゆるOpenAI互換クライアントと動作します。

POST /v1/chat/completions: リクエストの送信

標準エンドポイントを使用して最初のチャット完了リクエストを送信します。モデルIDを uncensored リクエストボディ内。APIは、システム、ユーザー、アシスタントのロールを含む標準的なメッセージ配列を受け入れます。これはOpenAI形式をサポートする任意のSDKで動作します。 model すべてのリクエストに含まれるフィールド。

Copyfrom openai import OpenAI

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

リクエストは当社のサーバーを介して処理されます。モデルはプロンプトに基づいて生成されたテキストで応答します。パラメータを調整できます。 temperature または top_p ランダム性を制御します。システムは生成されたコンテンツを含む完全なレスポンスオブジェクトを返します。

GET /v1/models: 利用可能なモデルのリスト

利用可能なオプションを確認するためにモデルエンドポイントをクエリします。GET リクエストを /v1/models ホストされているモデルを一覧表示します。応答には id フィールドは uncensored. このエンドポイントはAPIキーに有効な権限があることを確認します。モデル設定に関するメタデータを返します。

Copyimport OpenAI from "openai";

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

接続の問題をデバッグするにはこの呼び出しを使用してください。エンドポイントがエラーを返す場合は、認証ヘッダーを確認してください。エンドポイントは利用可能なモデルの簡単なリストを提供します。完全なチャットリクエストを送信せずに、サービスのステータスを確認できます。

サーバーサイドイベント（SSE）によるストリーミングレスポンス

streamを stream true に設定します。APIはリアルタイムのトークン配信のためにServer-Sent Events (SSE)を返します。各チャンクには部分的なコンテンツ更新が含まれます。最終チャンクには完全なトークン使用統計が含まれます。これにより長いレスポンスの知覚されるレイテンシーが低減します。

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)

クライアントコードでSSEストリームを処理します。各イベントは到着時に処理してください。最後のイベントには usage objectには入力および出力のトークン数が含まれます。ストリーミングはすべてのサポートされているパラメータと連携します。インタラクティブなアプリケーションに即時フィードバックを提供します。

構成パラメータ: 温度、Top-p など

などの標準的なパラメータを使用して生成動作を調整する。設定 temperature ランダム性と top_p ヌクレウスサンプリング用。使用 stop シーケンスで生成を早期に停止します。 seed パラメータは再現可能な結果を保証します。また、クライアント設定で presence_penalty および frequency_penalty スタイル制御用です。

JSONモードは response_format. これを json_object 構造化出力用です。モデルは指定されたフォーマットに従います。これらのパラメータはすべてのリクエストに適用されます。応答スタイルを微調整するために使用してください。

エラー処理とトークン使用量のレポート

アプリケーションで一般的なHTTPエラーを処理します。401ステータスはAPIキーが無効であることを示します。402ステータスはプリペイドクレジットが枯渇したことを意味します。429ステータスはレート制限を超えたことを示します。詳細なエラーメッセージはレスポンスボディを確認してください。コンテンツポリシーによる拒否は無料です。

コンテキストウィンドウは合計100,000トークンをサポートします。出力は1リクエストあたり16,000トークンに制限されます。未指定の場合、デフォルトの出力は2,048トークンです。 max_tokens 未設定。トークン使用量は最終ストリームチャンクで報告されます。エラーはクレジットを消費しません。