利用可能なモデルを取得

タイプ別に利用可能なモデルの一覧を取得します。主にナレッジベース設定用の text-embedding モデルと rerank モデルのクエリに使用します。

GET /workspaces/current/models/model-types/{model_type}

Error

A valid request URL is required to generate request examples

200

{
  "data": [
    {
      "provider": "openai",
      "label": {
        "en_US": "OpenAI",
        "zh_Hans": "OpenAI"
      },
      "icon_small": {
        "en_US": "https://example.com/openai-small.svg"
      },
      "icon_large": {
        "en_US": "https://example.com/openai-large.svg"
      },
      "status": "active",
      "models": [
        {
          "model": "text-embedding-3-small",
          "label": {
            "en_US": "text-embedding-3-small",
            "zh_Hans": "text-embedding-3-small"
          },
          "model_type": "text-embedding",
          "features": null,
          "fetch_from": "predefined-model",
          "model_properties": {
            "context_size": 8191
          },
          "status": "active"
        }
      ]
    }
  ]
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

model_type · enum<string> · 必須

取得するモデルのタイプです。ナレッジベースの設定には、埋め込みモデルの場合は text-embedding、リランキングモデルの場合は rerank を使用します。

利用可能なオプション: text-embedding, rerank, llm, tts, speech2text, moderation

レスポンス

200 - application/json

指定された種類で利用可能なモデルです。

data · object[]

利用可能なモデルを持つモデルプロバイダーのリストです。

Show child attributes