メタデータフィールドを作成

ナレッジベースのカスタムメタデータフィールドを作成します。メタデータフィールドを使用して、構造化された情報でドキュメントにアノテーションを付けることができます。

POST /datasets/{dataset_id}/metadata

Error

A valid request URL is required to generate request examples

201

{
  "id": "b5c6d7e8-f9a0-1b2c-3d4e-5f6a7b8c9d0e",
  "name": "author",
  "type": "string"
}

承認

Authorization · string · header · 必須

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

パスパラメータ

dataset_id · string<uuid> · 必須

ナレッジベース ID です。

ボディ

application/json

type · enum<string> · 必須

string はテキスト値、number は数値、time は日付/時刻値です。

利用可能なオプション: string, number, time

name · string · 必須

メタデータフィールド名です。

レスポンス

201 - application/json

メタデータフィールドが正常に作成されました。

id · string

メタデータフィールドの識別子です。

name · string

メタデータフィールド名です。

type · string

メタデータフィールドの種類です。