コンテンツにスキップ

LLM 設定の追加¶

POST /api/v1/llm_cfg/add

概要¶

新しい LLM アプリケーション設定を作成し、実際に有効になる appId と clientToken を返します。

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
appId	string		カスタム appId、最大 128 文字。英数字、アンダースコアのみ使用可能。未指定の場合は自動生成されます。空を許可: False 空文字列を許可: True $maxCharacterLength: 128
jsonContent	json	Y	JSON 形式の内容空を許可: False
jsonContent.name	string	Y	アプリケーション名。同一ワークスペース内で一意空を許可: False 最大長: 256
jsonContent.type	string	Y	アプリケーションタイプ。現在は `Langfuse` のみサポート空を許可: False 選択可能な値: ['Langfuse']
jsonContent.site	string		サイトアドレス。例: `https://cloud.langfuse.com` 空を許可: False
jsonContent.extend	json		その他の拡張設定。そのまま `jsonContent.extend` に格納空を許可: False
clientToken	string		カスタム clientToken。未指定の場合は自動生成。指定され、かつシステムに既に存在する場合は、既存のトークンレコードが再利用されます。空を許可: False 空文字列を許可: True

パラメータ補足説明¶

API 説明¶

新しい LLM アプリケーション設定を作成します。

作成ルール¶

appId はオプション。未指定の場合はバックエンドが自動生成
clientToken はオプション。未指定の場合はバックエンドが自動生成
appId を指定する場合、英数字、アンダースコアのみ使用可能
同一ワークスペース内で、appId の重複は許可されません
同一ワークスペース内で、jsonContent.name の重複は許可されません

`jsonContent` フィールド説明¶

フィールド	説明
`name`	アプリケーション名。外部表示名
`type`	アプリケーションタイプ。現在は `Langfuse` 固定
`site`	サイトアドレス。例: `https://cloud.langfuse.com`
`extend`	拡張設定。構造は業務要件に応じて透過的に渡されます

呼び出し成功後¶

アプリケーション設定が永続化されます
アプリケーションに clientToken がバインドされるか、既存のものが再利用されます
下流の LLM 統計/接続側にアプリケーション情報の更新が通知されます

エラー意味¶

ft.InvalidLlmAppId：appId に不正な文字が含まれています
ft.SignNameRepeat：appId が重複しています
ft.LlmCfgNameRepeat：アプリケーション名が重複しています

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/llm_cfg/add' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json;charset=UTF-8' \
  --data-raw '{"appId":"llm_app_demo","jsonContent":{"name":"Langfuse Prod","type":"Langfuse","site":"https://cloud.langfuse.com","extend":{"service":"prod"}}}' \
  --compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "appId": "llm_app_demo",
        "createAt": 1690813059,
        "creator": "acnt_xxxx32",
        "deleteAt": -1,
        "id": 1,
        "jsonContent": {
            "name": "Langfuse Prod",
            "type": "Langfuse",
            "site": "https://cloud.langfuse.com",
            "extend": {
                "service": "prod"
            }
        },
        "status": 0,
        "updateAt": 1690813059,
        "updator": "acnt_xxxx32",
        "uuid": "llm_app_demo",
        "workspaceUUID": "wksp_xxxx32",
        "clientToken": "token_xxx"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-68EEEB4A-9ABC-4DDB-A72B-40F07F2699A5"
}