メインコンテンツへスキップ
POST
/
completion-messages
Error
A valid request URL is required to generate request examples
{
  "event": "<string>",
  "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mode": "<string>",
  "answer": "<string>",
  "metadata": {
    "usage": {
      "prompt_tokens": 123,
      "prompt_unit_price": "<string>",
      "prompt_price_unit": "<string>",
      "prompt_price": "<string>",
      "completion_tokens": 123,
      "completion_unit_price": "<string>",
      "completion_price_unit": "<string>",
      "completion_price": "<string>",
      "total_tokens": 123,
      "total_price": "<string>",
      "currency": "<string>",
      "latency": 123
    },
    "retriever_resources": [
      {
        "document_id": "<string>",
        "segment_id": "<string>",
        "score": 123,
        "content": "<string>"
      }
    ]
  },
  "created_at": 123
}

認証

​
Authorization
string
header
必須

API-Key認証。すべてのAPIリクエストで、Authorization HTTPヘッダーに Bearer {API_KEY} の形式でAPIキーを含めてください。APIキーの漏洩を避けるため、サーバーサイドでの保存を強く推奨します。

ボディ

application/json

完了メッセージを作成するためのリクエストボディ。

​
inputs
object
必須

アプリで定義された各種変数値を入力。少なくとも1つのキー/値ペアが必要。

​
response_mode
enum<string>
デフォルト:streaming

レスポンス返却モード。streaming (推奨): SSEによるタイプライター風出力。blocking: 実行完了後に結果返却 (Cloudflare 100秒制限あり)。

利用可能なオプション:
streaming,
blocking
​
user
string

ユーザー識別子。アプリケーション内で開発者が一意に定義。

​
files
object[]

(任意) ファイルリスト。モデルがVision機能をサポートしている場合のみ利用可能。

レスポンス

リクエスト成功。レスポンスのコンテントタイプと構造はリクエストの response_mode パラメータに依存します。

  • response_mode が blocking の場合、application/json で CompletionResponseJp オブジェクトを返します。
  • response_mode が streaming の場合、text/event-stream で ChunkCompletionEventJp のストリームを返します。

ブロッキングモードでのアプリの完全な結果。

​
event
string

イベントタイプ、通常 'message'。(MarkdownではChatCompletionResponseで 'chat' とあったが、Completionの文脈では 'completion' or 'message' が一般的。blocking example に合わせて 'message' を使用)

​
message_id
string<uuid>

一意のメッセージID。

​
mode
string

アプリモード。ブロッキングモードの例では 'completion'、Markdown本文では 'chat' と記載。ここでは 'completion' を採用。

​
answer
string

完全な応答内容。

​
metadata
object

メタデータ。

​
created_at
integer<int64>

メッセージ作成タイムスタンプ。