KiApiドキュメント：5分で統合

はじめに：ベースURLと認証

KiApiはOpenAI APIと完全に互換性があります。既存のSDKおよびクライアントのエコシステムを、base_urlを変更するだけで利用可能です。すべてのリクエストのベースURLはhttps://api.kiapis.com/v1です。認証は、登録後にダッシュボードページで取得するAPIキーのみによって行われます。このキーはHTTPヘッダーAuthorization: Bearer <IHR_API_SCHLÜSSEL>に含めて送信する必要があります。いつでも新しいキーを生成でき、古いキーは無効になります。

他のサービスとは異なり、埋め込みやファインチューニングのための複雑なエンドポイントは提供しません。私たちの焦点は純粋なテキスト生成にあります。KiApiは、無検閲の応答に最適化されたモデルへの直接の接続です。最初のリクエストを送信する前に、環境を正しく構成してください。

POST /v1/chat/completions：テキスト生成

APIの中核はエンドポイントPOST /v1/chat/completionsです。ここで、メッセージ（システム、ユーザー、アシスタント）のリストを送信し、テキスト応答を受け取ります。モデルIDパラメータはuncensoredに設定する必要があります。応答は同期しており、生成されたテキストの断片とトークン使用量のメタデータを即座に含みます。

リクエストの構造は標準フォーマットに従います。役割を定義してコンテキストを明確に構造化できます。システムは入力を処理し、モデルの学習された動作に基づいて応答を生成します。これは、チャットボットからテキスト分析に至るまで、ほぼすべてのテキストアプリケーションのための主要な方法です。

Kopierencurl https://api.kiapis.com/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."}]
  }'

応答には生成されたコンテンツを含むJSONオブジェクトが含まれます。アプリケーションで再利用するために、応答からcontent領域を抽出してください。標準応答にはリクエストごとのコストなどの追加メタデータは返されません。これらはダッシュボードで確認できます。

サーバー送信イベント（SSE）によるストリーミング

即時の出力が必要なアプリケーションの場合、KiApiはサーバー送信イベント（SSE）によるストリーミングをサポートします。リクエストボディに"stream": trueを設定して有効にします。完全な応答を待つ代わりに、生成されたテキストを段階的に含むJSONパッチのストリームを受け取ります。

これは、即時フィードバックがユーザーエクスペリエンスを向上させるチャットインターフェースに特に役立ちます。KiApiストリーミングAPIを使用することで、レイテンシを削減し、リアルタイムの会話の感覚を生み出すことができます。クライアントはストリームを解析し、ストリームの終了がシグナルされるまで断片を結合する必要があります。

Kopierenstream = 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)

ストリーミング中、トークン使用統計は通常、ストリームの最後のイベントで返されます。これにより、実際の生成長に基づいた正確な課金が可能になります。クライアントコードがストリームの終了を処理し、リソースを正しく解放するようにしてください。

ツール呼び出しと関数呼び出し

モデルはツール呼び出し（関数呼び出しとも呼ばれる）をサポートしています。これにより、LLMはアプリケーション内の特定の機能やアクションを表す構造化されたJSONデータを返すことができます。リクエストボディで利用可能なツールを定義し、モデルはユーザー入力を基にツールを呼び出すタイミングを判断します。

ツールの定義構造はOpenAIの標準に従います。複数のツールを指定でき、モデルは最も適切なものを選択します。応答にはツール呼び出しのリストが含まれており、バックエンドロジックで実行できます。これにより、KiApiの可能性は純粋なテキスト生成を超えて大幅に拡張されます。

Kopierenfrom openai import OpenAI

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

ツール呼び出しを使用して複雑なワークフローを自動化します。モデルはツールのパラメータをJSON形式で直接提供します。応答の構造はモデルから直接来るため、外部パーサーを使用する必要はありません。これにより、既存システムへの統合が大幅に容易かつ信頼性が高まります。

GET /v1/models：利用可能なモデル

エンドポイントGET /v1/modelsは、APIを通じてアクセス可能な利用可能なモデルを一覧表示します。これは、利用可能なモデルを動的に確認したり、モデルIDを確認したりするために便利です。通常、モデルuncensoredのリストが返されます。

応答には、ID、所有者、作成日などのモデルメタデータが含まれます。他のいくつかのAPIとは異なり、標準応答には最大コンテキスト長や特定の価格が直接含まれていません。これらの情報はドキュメントまたはダッシュボードから取得する必要があります。ただし、このエンドポイントはクライアントの自動構成に不可欠です。

Kopierenimport OpenAI from "openai";

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

このエンドポイントを使用して、アプリケーションを将来の変更に合わせてください。新しいモデルが追加されると、自動的にこのリストに表示されます。現在のモデルuncensoredは唯一の利用可能なモデルであり、無検閲コンテンツに最適化された大規模言語モデルとして説明されます。

レート制限とエラーコード

サービスの安定性を確保するために、特定の制限が適用されます。APIキーごとに1分あたり300リクエストが許可されています。最大リクエストボディサイズは8 MBです。これらの制限を超えると、HTTPステータスコード429 Too Many Requestsが返されます。指数バックオフによる再試行を実装するようにアプリケーションを計画してください。

その他の一般的なエラーコードには、APIキーが無効な場合に返される401 Unauthorized、およびクレジットが枯渇した場合に返される402 Payment Requiredがあります。KiApiは前払いモデルを使用しているため、クレジットがないリクエストは即座に拒否されます。アカウント残高を定期的に確認してください。

コンテキストウィンドウは、入力と出力を合わせて100,000トークンです。この制限を超えると、エラーメッセージが返されます。KiApiは、明確なルールと透過的な制限を重視する開発者にとって信頼性の高いソリューションです。