アノテーションを作成

対象アプリ：Chatflow、チャットボット、Agent。

アノテーションを作成します。アノテーションは、一致したときにアプリが新しい応答を生成する代わりに直接返す、事前定義された質問と回答のペアです。

POST /apps/annotations

アノテーションを作成

cURL

curl --request POST \
  --url https://{api_base_url}/apps/annotations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "question": "What is Dify?",
  "answer": "Dify is an open-source LLM application development platform."
}
'

import requests

url = "https://{api_base_url}/apps/annotations"

payload = {
    "question": "What is Dify?",
    "answer": "Dify is an open-source LLM application development platform."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    question: 'What is Dify?',
    answer: 'Dify is an open-source LLM application development platform.'
  })
};

fetch('https://{api_base_url}/apps/annotations', 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}/apps/annotations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'question' => 'What is Dify?',
    'answer' => 'Dify is an open-source LLM application development platform.'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://{api_base_url}/apps/annotations"

	payload := strings.NewReader("{\n  \"question\": \"What is Dify?\",\n  \"answer\": \"Dify is an open-source LLM application development platform.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{api_base_url}/apps/annotations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"question\": \"What is Dify?\",\n  \"answer\": \"Dify is an open-source LLM application development platform.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{api_base_url}/apps/annotations")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"question\": \"What is Dify?\",\n  \"answer\": \"Dify is an open-source LLM application development platform.\"\n}"

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

201

{
  "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  "question": "What is Dify?",
  "answer": "Dify is an open-source LLM application development platform.",
  "hit_count": 0,
  "created_at": 1705407629
}

Authorizations

Authorization · string · header · required

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

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

Body

application/json

新しいアノテーションを作成するためのリクエストボディです。

question · string · required

アプリが受信したユーザー入力を照合する質問テキストです。

answer · string · required

このアノテーションが一致したときに返される回答です。

Response

201 - application/json

アノテーションが正常に作成されました。

id · string<uuid>

アノテーションの一意識別子です。

question · string | null

このアノテーションをトリガーする質問テキストです。

answer · string | null

アノテーションがマッチした際に返される定義済みの回答です。

hit_count · integer | null

このアノテーションがマッチして返信として返された回数です。

created_at · integer<int64> | null

作成タイムスタンプ（Unix エポック秒）。