プライベートAIサービス・コンテナAPIリファレンス

models

GETリクエストを使用して、現在デプロイされているすべてのモデルのリストを出力します。

構文

/v1/models

戻り値

デプロイされたモデルのリスト。

出力例

{
  "data": [
    {
      "id": "h126414603234059290",
      "modelSize": "string",
      "modelDeployedTime": "2025-12-22T15:49:11.745Z",
      "modelCapabilities": [
        "TEXT_EMBEDDINGS"
      ]
    }
  ]
}

models/{id}

GETリクエストを使用して、特定のモデルに関する情報を出力します。

構文

/v1/models/{id}

パラメータ

id (string): 一意のモデル名。このパラメータは必須です。

戻り値

モデルIDで指定されたモデルに関する情報。

出力例

{
  "id": "L55808652807957200809612118083123839056757756025",
  "modelSize": "string",
  "modelDeployedTime": "2025-12-22T16:52:28.365Z",
  "modelCapabilities": [
    "TEXT_EMBEDDINGS"
  ]
}

embeddings

POSTリクエストを使用して、モデルに対する埋込みを取得します。

構文

/v1/embeddings

パラメータ

x-convert-images (boolean): 入力リストのイメージがJPGへの変換を必要とするかどうかを示します。デフォルト値はfalseです。

入力例

inputには、文字列または文字列の配列を指定できます。

{
  "input": "string",
  "model": "string"
}

出力例

埋込みの結果:

{
  "data": [
    {
      "embedding": [
        0
      ],
      "index": 0
    }
  ],
  "model": "string"
}

400: リクエスト・データの処理中にエラーが発生しました。
404: モデルが見つかりません。
500: このモデルのスコア処理中にエラーが発生しました。

health

GETリクエストを使用して、コンテナを使用する準備ができていることを確認します。

構文

/health

出力例

200: プライベートAIサービス・コンテナは稼働しています。
401: 認可されていません
500: 内部サーバー・エラー

metrics

GETリクエストを使用して、アプリケーションによって公開されているメトリック名のリストを戻します。

構文

/metrics

戻り値

アプリケーションによって公開されているメトリック名のリストを戻します。

出力例

メトリック名を含む正常なレスポンス:

{
  "names": [
    "embeddings_call_error_total",
    "embeddings_call_latency",
    "embeddings_call_success_total",
    "embeddings_call_total",
    "embeddings_last_latency",
    "http.server.requests",
    "jvm.memory.used",
    "process.cpu.usage",
    "system.cpu.usage"
  ]
}

401: 認可されていません
500: 内部サーバー・エラー

metrics/{metricName}

GETリクエストを使用して、測定値や使用可能なタグなど、メトリックに関する詳細情報を戻します。key:value形式のtag問合せパラメータを繰り返し使用するオプションのタグ・フィルタをサポートします。

構文

/metrics/{metricName}

パラメータ

metricName (string): GET /metricsによって戻されるメトリック名。このパラメータは必須です。

tag (array<string>): key:value形式のタグ・フィルタ。複数のタグの場合は、繰り返します。

出力例

メトリックの詳細:

{
  "name": "embeddings_call_error_total",
  "description": "Total number of errors from embeddings calls.",
  "baseUnit": "count",
  "measurements": [
    {
      "statistic": "COUNT",
      "value": 3
    }
  ],
  "availableTags": [
    {
      "tag": "model"
    },
    {
      "tag": "status",
      "values": [
        "success",
        "error"
      ]
    }
  ]
}

400: タグ・フィルタが無効です
404: メトリックが見つかりません
500: 内部サーバー・エラー

api

GETリクエストを使用して、このAPIのOpenAI仕様をYAML形式で戻します。

構文

/v1/api

戻り値

OpenAPI (YAML)ドキュメントを文字列として戻します。

A プライベートAIサービス・コンテナAPIリファレンス