LLM 設定の取得¶
GET /api/v1/llm_cfg/{appid}/get
概要¶
LLM アプリケーションの詳細、収集 Token、統計を取得します。
呼び出し前の準備と使用手順¶
現在の Key の権限は routine.defaultAccess または llm.llmCfgManage のいずれかに該当する必要があり、対象は現在のワークスペースに限られます。組み込み Agent モニタリングアプリはこのグループのリストには表示されず、詳細取得で対象または組み込み対象が存在しない場合は 404 を返します。専用の組み込みアプリの管理にこの 6 つのインターフェースを使用しないでください。公開インターフェースは appType やクロスワークスペースのパラメータを受け付けず、フロントエンド/AI エントリの追加フィルタや返却時のプロジェクションをそのまま流用することはできません。
リスト/詳細は Client Token の平文を返します。これは収集接続用の認証情報であるため、権限を付与された接続先にのみ渡してください。DF-API-KEY をクライアント収集 Token として扱わないでください。ifTokenExpired は互換性のための状態ヒントにすぎず、同一ワークスペースへの帰属や実際の利用可否を証明するものではありません。リストではレコードが存在しない場合に false となることさえあります。まず現在のワークスペースの有効な Token と実際の収集状況を確認してください。
この公開 get は timeRange を宣言/送信しないため、統計は固定でデフォルトの直近 24 時間を使用します。フロントエンド get の調整可能なウィンドウを流用しないでください。statisticalInfo はアプリケーション名でマッチングし、異常/データなし/LLM 以外のアプリケーションの場合はすべて null になります。HTTP 200 はデータが収集済みであることを保証するものではありません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| appid | string | Y | 現在の Key ワークスペースの公開 appId。内部の実際の LlmCfg UUID ではありません。パスはそのまま URL エンコードされます。 例: payment_llm取得または入力方法: LLM アプリケーション簡易一覧 から content[].appId を取得します(uuid は同じ公開エイリアスです)。またはページングリストの content.data[].appId から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
パラメータ補足説明¶
appId は公開アプリケーション識別子、uuid はその互換エイリアスです。本ページの実際の Token、統計、エラーの境界に従って使用し、フロントエンド/AI インターフェースの追加パラメータをそのまま流用しないでください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/llm_cfg/payment_llm/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | アプリケーション詳細と Token 平文/統計。 |
| content.id | integer または null | データベース行 ID。パスの特定には使用しません。送信前のスナップショットでは null になる場合があります。 |
| content.uuid | string | 公開互換エイリアスで、appId と等しくなります。内部の実際の LlmCfg UUID ではありません。 |
| content.status | integer | リソース状態。通常は 0、論理削除の 3 はクエリから除外されます。 |
| content.creator | string | 作成主体の UUID。現在の OpenAPI では通常 Key リソースの wsak_ です。 |
| content.updator | string | 最終更新主体。未更新の場合は空になることがあります。 |
| content.createAt | integer | Unix 秒の作成時刻。 |
| content.updateAt | integer | Unix 秒の更新時刻。未更新の場合は通常 -1 です。 |
| content.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1 です。 |
| 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.clientToken | string | リスト/詳細/作成では Client Token の平文です。変更時にパラメータを省略/空にした場合は内部 wctn_ UUID の互換分岐があり、詳細は該当ページを参照してください。 |
| content.ifTokenExpired | boolean | Token 状態の互換ヒント。リスト: レコードが存在し status が 3 の場合に true、レコードが存在しない場合はむしろ false になります。詳細: 同じ平文に未削除のレコードが任意に存在するかどうかで判定します。false は現在のワークスペースの Token が収集可能または有効であることを保証するものではありません。 |
| content.statisticalInfo | object | 下流の集約統計。jsonContent.name でマッチングします。データなし、LLM 以外のアプリケーション、または集約異常の場合はすべて null となり、0 として扱うべきではありません。 |
| content.statisticalInfo.callCount | number または null | ウィンドウ内の呼び出し数。 |
| content.statisticalInfo.errorCount | number または null | ウィンドウ内のエラー数。 |
| content.statisticalInfo.tokensCount | number または null | ウィンドウ内の Token 総量。 |
| content.statisticalInfo.inputTokens | number または null | ウィンドウ内の入力 Token 量。 |
| content.statisticalInfo.outputTokens | number または null | ウィンドウ内の出力 Token 量。 |
| content.statisticalInfo.p50 | number または null | リクエスト遅延の 50 パーセンタイル。Studio は集約値をそのまま転送し、単位を変換しません。使用時は収集/集約元の単位と一致させてください。 |
| content.statisticalInfo.p75 | number または null | リクエスト遅延の 75 パーセンタイル。単位の基準は p50 と同じです。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"id": 7,
"uuid": "payment_llm",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"appId": "payment_llm",
"appType": "",
"jsonContent": {
"name": "支付助手",
"type": "Langfuse",
"site": "https://llm.example.com",
"extend": {
"team": "payment"
}
},
"clientToken": "<LLM-CLIENT-TOKEN>",
"ifTokenExpired": false,
"statisticalInfo": {
"callCount": null,
"errorCount": null,
"tokensCount": null,
"inputTokens": null,
"outputTokens": null,
"p50": null,
"p75": null
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対応方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundLlmSet | アプリケーションが存在しない/削除済み/現在のワークスペースに存在しない、または非表示の Agent モニタリング組み込みアプリに属している | 指定された LLM 設定が見つかりません | このグループの簡易一覧から公開 appId を再選択してください。組み込みアプリは製品専用の管理エントリを使用してください。 |
| 500 | ft.InternalServerError | データベース/Token の読み取り、履歴 jsonContent/appType、下流 rollup レスポンス形状の構築などの未処理例外 | 内部エラー | アプリケーション/Token の設定と traceId を確認し、バックオフして再試行してください。集約クエリの異常は通常フォールトトレラントで全 null になり、呼び出し数が 0 であることを意味しません。 |