メタデータフィールドリストを取得

ナレッジベースのすべてのメタデータフィールド（カスタムおよび組み込みの両方）の一覧と、各フィールドを使用しているドキュメント数を返します。

GET /datasets/{dataset_id}/metadata

メタデータフィールドリストを取得

cURL

curl --request GET \
  --url https://{api_base_url}/datasets/{dataset_id}/metadata \
  --header 'Authorization: Bearer <token>'

200

{
  "doc_metadata": [
    {
      "id": "b5c6d7e8-f9a0-1b2c-3d4e-5f6a7b8c9d0e",
      "name": "author",
      "type": "string",
      "count": 3
    }
  ],
  "built_in_field_enabled": true
}

承認

Authorization · string · header · 必須

API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例：Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。

パスパラメータ

dataset_id · string<uuid> · 必須

ナレッジベース ID です。

レスポンス

200 - application/json

ナレッジベースのメタデータフィールドです。

doc_metadata · object[]

メタデータフィールド定義のリスト。

Show child attributes

built_in_field_enabled · boolean

このナレッジベースで組み込みメタデータフィールドが有効かどうかです。