組み込みメタデータフィールドを取得

システムが提供する組み込みメタデータフィールドを返します。

GET /datasets/{dataset_id}/metadata/built-in

組み込みメタデータフィールドを取得

cURL

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

import requests

url = "https://{api_base_url}/datasets/{dataset_id}/metadata/built-in"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{api_base_url}/datasets/{dataset_id}/metadata/built-in', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{api_base_url}/datasets/{dataset_id}/metadata/built-in",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{api_base_url}/datasets/{dataset_id}/metadata/built-in"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{api_base_url}/datasets/{dataset_id}/metadata/built-in")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/datasets/{dataset_id}/metadata/built-in")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "fields": [
    {
      "name": "document_name",
      "type": "string"
    },
    {
      "name": "uploader",
      "type": "string"
    },
    {
      "name": "upload_date",
      "type": "time"
    },
    {
      "name": "last_update_date",
      "type": "time"
    },
    {
      "name": "source",
      "type": "string"
    }
  ]
}

{
  "status": 403,
  "code": "forbidden",
  "message": "Dataset api access is not enabled."
}

{
  "status": 404,
  "code": "not_found",
  "message": "Dataset not found."
}

Authorizations

Authorization · string · header · required

すべてのリクエストは API キーで認証します：Authorization: Bearer {API_KEY}。アプリのエンドポイントにはアプリの API キーを、ナレッジのエンドポイントにはナレッジベースの API キーを使用します（Dify API クイックスタート）。

キーはサーバーサイドで保管し、クライアントコードには決して埋め込まないでください。キーが欠落または無効なリクエストは HTTP 401（unauthorized）で失敗します。

Path Parameters

dataset_id · string<uuid> · required

ナレッジベース ID です。ナレッジベースリストを取得 を参照してください。

Response

200

application/json

組み込みメタデータフィールドです。

fields · object[]

システム提供のメタデータフィールドのリストです。

Show child attributes