コンテンツにスキップ

LLM 設定のクイック一覧



GET /api/v1/llm_cfg/quick_list

概要

現在のワークスペースの LLM アプリケーション簡易一覧を取得します。

呼び出し前の確認と使用手順

現在の Key の権限は routine.defaultAccess または llm.llmCfgManage のいずれかに一致している必要があり、対象は現在のワークスペースのみです。組み込み Agent モニタリングアプリケーションはこのグループ一覧では非表示になり、詳細で対象/組み込み対象が存在しない場合は 404 を返します。これら 6 つのエンドポイントで専用の組み込みアプリケーションを管理しないでください。公開 API では appType やワークスペースをまたぐパラメーターを受け付けません。フロントエンド/AI エントリーポイントにおける追加のフィルタリングやレスポンス投影をそのまま踏襲することはできません。

appId/appType/jsonContent/uuid/workspaceUUID のみを返し、Token、統計、ページネーションは含みません。配列そのものの各非空項目には declaration が追加されます。uuid は appId と同じです。

リクエストヘッダー

パラメーター名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメーター

パラメーター名 型 必須 説明
appId commaArray 任意のカンマ区切り文字列。文字列全体の先頭と末尾の空白を除去してから分割し、各項目は個別に trim しません。省略または空の場合は ID でフィルタリングしません。JSON 配列ではありません。
null を許可: False
例: payment_llm,assistant_llm
取得または入力方法: LLM アプリケーション簡易一覧 から content[].appId(uuid は同じ公開別名)を取得するか、ページネーション一覧の content.data[].appId を取得します。
search string 任意。先頭と末尾の空白を除去し、SQL ILIKE によるあいまい一致を行います。%/_ はワイルドカードの意味を保持します。
null を許可: False
例: 支付
取得または入力方法: アプリケーションの jsonContent.name で検索します。
type string 任意の完全一致する型。省略時はフィルタリングしません。公開列挙値は Langfuse のみです。
null を許可: False
選択可能な値: ['Langfuse']
例: Langfuse
取得または入力方法: 現在公開されているフィルタリング可能な型は Langfuse です。

パラメーター補足説明

appId は公開アプリケーション識別子、uuid はその互換別名です。本ページの実際の Token、統計、エラー境界に従って使用し、フロントエンド/AI インターフェースの追加パラメーターをそのまま流用しないでください。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/llm_cfg/quick_list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode type=Langfuse

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content array<object> 現在のワークスペースのアプリケーション簡易一覧。一致するものがない場合は []。
content[].uuid string 公開互換別名。appId と同じで、内部の実際の LlmCfg UUID ではありません。
content[].workspaceUUID string 現在の Key が属するワークスペース。
content[].appId string 公開アプリケーション ID。デフォルトでは llmcfg_ プレフィックス付きの値が自動生成されます。
content[].appType string アプリケーションファミリのマーカー。公開作成では通常空です。履歴では llm/agent/obsyTeam などを取る場合がありますが、この公開入力では appType を使用できません。
content[].jsonContent object アプリケーションの表示/連携設定。宣言されていない追加のトップレベル子キーを含めて書き込むことはできません。
content[].jsonContent.name string アプリケーションの表示名。統計はこの名前で照合されます。
content[].jsonContent.type string 公開書き込みでは Langfuse のみです。履歴の型は異なる場合がありますが、公開での書き戻しが可能であることを意味しません。
content[].jsonContent.site string 任意で保存されるサイトアドレス。サーバー側はこのフィールドによってサードパーティプロジェクトを自動作成したり、接続可能かどうかを検証したりしません。
content[].jsonContent.extend object 任意の動的拡張オブジェクト。指定しない場合はキーを省略できます。
content[].jsonContent.extend.カスタムキー JSON そのまま保存される JSON 値。追加の実行/認証設定を保証するものではありません。
content[].declaration object または null 現在のワークスペースの共通宣言。
{
  "code": 200,
  "content": [
    {
      "uuid": "payment_llm",
      "appId": "payment_llm",
      "appType": "",
      "jsonContent": {
        "name": "支付助手",
        "type": "Langfuse",
        "site": "https://llm.example.com",
        "extend": {
          "team": "payment"
        }
      },
      "workspaceUUID": "wksp_example",
      "declaration": {}
    }
  ],
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメーターを使用した、またはパラメーターが規則に違反している パラメーター解析失敗 Query パラメーター表と例を確認してください。
500 ft.InternalServerError データベース読み取り、履歴の jsonContent/appType 形状、または軽量一覧投影などの未処理例外 内部エラー 現在のワークスペースのアプリケーション設定と traceId を確認してからバックオフして再試行してください。このエントリーポイントでは統計やページネーションを照会しません。

フィードバック

このページは役に立ちましたか?