メインコンテンツまでスキップ

Knowledge API

概要: 「独自知識」(Knowledge) は、ユーザーが事前登録するテキスト片で、文書変換時に LLM への事前知識として注入できます。Conversions API の knowledge_ids パラメータで指定することで、画像のキャプション生成等に独自のドメイン知識を反映させられます。

アクセスレベル​

各 Knowledge には次のいずれかのアクセスレベルが設定されます:

アクセスレベル条件共有範囲
personalspace_id を指定せずに作成作成ユーザーのみ
spacespace_id を指定して作成（書き込み権限が必要）スペース所属メンバー全員

GET /v1/user/knowledge​

ユーザー（または指定スペース）に登録されている独自知識の一覧を取得します。

GET /v1/user/knowledge

Headers​

  • api-key : string(required) - rokadoc APIキー

Query Parameters​

必須パラメータ​

なし

オプショナルパラメータ
  • space_id : string(optional) - スペース機能を利用する場合はスペースIDを指定。指定するとそのスペースの space レベル知識が返却される。未指定の場合はユーザー個人の personal 知識が返却される

Request Example​

curl -X 'GET' \
"https://api.rokadoc.ntt.com/v1/user/knowledge" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - 一覧取得成功​
{
  "code": 200,
  "data": [
    {
      "knowledge_id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "title": "地図の読み方",
      "content": "地図を読み込むときは、まず縮尺を確認します。...",
      "registered_user_id": "xxxxxxxxxxxx"
    }
  ]
}
  • code : integer - ステータスコード
  • data : array - 独自知識の配列
    • knowledge_id : string - 知識ID（knowledge_ids パラメータで参照する値）
    • title : string - タイトル
    • content : string - 知識本文
    • registered_user_id : string - 登録したユーザーID

POST /v1/api/knowledge​

独自知識を新規作成します。

POST /v1/api/knowledge

Headers​

  • api-key : string(required) - rokadoc APIキー

Request Body (multipart/form-data)​

必須パラメータ​
  • title : string(required) - 知識のタイトル
  • content : string(required) - 知識の本文
オプショナルパラメータ
  • space_id : string(optional) - スペース専用として登録する場合に指定。指定するとそのスペースの書き込み権限チェックが行われ、access_level=space で保存される

Request Example​

curl -X 'POST' \
"https://api.rokadoc.ntt.com/v1/api/knowledge" \
-H "api-key: ${ROKADOC_API_KEY}" \
-F "title=地図の読み方" \
-F "content=地図を読み込むときは、まず縮尺を確認します。"

Response​

200 OK - 作成成功​
{
  "code": 200,
  "data": {
    "knowledge_id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "title": "地図の読み方",
    "content": "地図を読み込むときは、まず縮尺を確認します。",
    "registered_user_id": "xxxxxxxxxxxx"
  }
}

注意事項​

  • space_id を指定した場合、対象スペースに対する書き込み権限が必要です（権限が無い場合はエラー）
  • 作成後の knowledge_id を Conversions API の knowledge_ids パラメータに渡すことで、変換時に LLM への事前知識として利用できます

PUT /v1/api/knowledge/{knowledge_id}​

既存の独自知識を更新します。

PUT /v1/api/knowledge/{knowledge_id}

Headers​

  • api-key : string(required) - rokadoc APIキー

Request Body (multipart/form-data)​

必須パラメータ​
  • knowledge_id : string(required) - 更新対象の知識ID（パスパラメータ）
オプショナルパラメータ
  • title : string(optional) - 更新後のタイトル（デフォルト: 空文字）
  • content : string(optional) - 更新後の本文（デフォルト: 空文字）
  • space_id : string(optional) - スペース専用として更新する場合に指定（書き込み権限が必要）

Request Example​

curl -X 'PUT' \
"https://api.rokadoc.ntt.com/v1/api/knowledge/${KNOWLEDGE_ID}" \
-H "api-key: ${ROKADOC_API_KEY}" \
-F "title=地図の読み方（改訂版）" \
-F "content=地図を読み込むときは、まず縮尺と方角を確認します。"

Response​

200 OK - 更新成功​
{
  "code": 200,
  "data": {
    "knowledge_id": "xxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "title": "地図の読み方（改訂版）",
    "content": "地図を読み込むときは、まず縮尺と方角を確認します。",
    "registered_user_id": "xxxxxxxxxxxx"
  }
}

注意事項​

  • 自分が登録した（または所属スペースの書き込み権限がある）知識のみ更新可能です
  • title / content は省略するとそれぞれ空文字で上書きされます。一部のフィールドのみを変更したい場合でも、変更しないフィールドの現在値を合わせて送信してください

DELETE /v1/api/knowledge/{knowledge_id}​

独自知識を削除します。

DELETE /v1/api/knowledge/{knowledge_id}

Headers​

  • api-key : string(required) - rokadoc APIキー
  • space_id : string(optional) - スペース専用知識を削除する場合に指定（書き込み権限が必要）
必須パラメータ​
  • knowledge_id : string(required) - 削除対象の知識ID（パスパラメータ）

Request Example​

curl -X 'DELETE' \
"https://api.rokadoc.ntt.com/v1/api/knowledge/${KNOWLEDGE_ID}" \
-H "api-key: ${ROKADOC_API_KEY}"

Response​

200 OK - 削除成功​
{
  "code": 200
}

注意事項​

  • 自分が登録した（または所属スペースの書き込み権限がある）知識のみ削除可能です
  • スペース知識を削除する場合は space_id ヘッダーを指定してください
  • 削除後、その knowledge_id を変換時に指定するとエラーになるため、利用箇所での参照解除も合わせて行ってください