ナレッジベースの状態を更新する - AI Coding Assistant Lingma

この API を呼び出して、ナレッジベースのステータスを更新します。

サポートされているエディション

Enterprise Dedicated Edition

サービスエンドポイントと承認情報

API リクエスト構文の <domain> をエンドポイントに置き換えるためのサービスエンドポイントを取得します。
アクセストークンを取得します。
organizationId を取得します。 Lingma コンソールに移動し、[企業設定] > > [組織] の下の [基本情報] ページで組織 ID を確認します。

製品	リソース	必要な権限
AI コーディングアシスタント	ナレッジベース	読み取りと書き込み

リクエスト構文

POST https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/updateState

リクエストヘッダー

パラメーター	タイプ	必須	説明	例
`x-yunxiao-token`	文字列	はい	アクセストークン。	pt-0fh3**0fbG_35af**0484

リクエストパラメーター

パラメーター	タイプ	位置	必須	説明	例
`organizationId`	文字列	パス	はい	組織 ID。	99d1****71d4
`kbId`	文字列	パス	はい	ナレッジベースの ID。
`state`	文字列	クエリ	はい	ナレッジベースのステータス。有効な値: `enable` `disable`	enable

リクエスト例

curl -X 'POST' \
  'https://{domain}/oapi/v1/lingma/organizations/{organizationId}/knowledgeBases/{kbId}/updateState?state={state}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

レスポンスパラメーター

パラメーター	タイプ	説明	例
-	オブジェクト
`success`	ブール値	ナレッジベースのステータスが更新されたかどうかを示します。

レスポンス例

{
    "success": "false"
}

エラーコード

詳細については、「エラーコード」をご参照ください。