アノテーション返信を設定
curl --request POST \
--url https://{api_base_url}/apps/annotation-reply/{action} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"score_threshold": 0.9,
"embedding_provider_name": "openai",
"embedding_model_name": "text-embedding-3-small"
}
'import requests
url = "https://{api_base_url}/apps/annotation-reply/{action}"
payload = {
"score_threshold": 0.9,
"embedding_provider_name": "openai",
"embedding_model_name": "text-embedding-3-small"
}
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({
score_threshold: 0.9,
embedding_provider_name: 'openai',
embedding_model_name: 'text-embedding-3-small'
})
};
fetch('https://{api_base_url}/apps/annotation-reply/{action}', 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/annotation-reply/{action}",
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([
'score_threshold' => 0.9,
'embedding_provider_name' => 'openai',
'embedding_model_name' => 'text-embedding-3-small'
]),
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/annotation-reply/{action}"
payload := strings.NewReader("{\n \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\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/annotation-reply/{action}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/apps/annotation-reply/{action}")
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 \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"job_status": "waiting"
}アノテーション管理
アノテーション返信を設定
アノテーション返信機能を有効または無効にします。有効にする場合は埋め込みモデルの設定が必要です。非同期で実行されます——アノテーション返信の初期設定タスクステータスを取得 で進捗を追跡します。
POST
/
apps
/
annotation-reply
/
{action}
アノテーション返信を設定
curl --request POST \
--url https://{api_base_url}/apps/annotation-reply/{action} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"score_threshold": 0.9,
"embedding_provider_name": "openai",
"embedding_model_name": "text-embedding-3-small"
}
'import requests
url = "https://{api_base_url}/apps/annotation-reply/{action}"
payload = {
"score_threshold": 0.9,
"embedding_provider_name": "openai",
"embedding_model_name": "text-embedding-3-small"
}
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({
score_threshold: 0.9,
embedding_provider_name: 'openai',
embedding_model_name: 'text-embedding-3-small'
})
};
fetch('https://{api_base_url}/apps/annotation-reply/{action}', 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/annotation-reply/{action}",
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([
'score_threshold' => 0.9,
'embedding_provider_name' => 'openai',
'embedding_model_name' => 'text-embedding-3-small'
]),
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/annotation-reply/{action}"
payload := strings.NewReader("{\n \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\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/annotation-reply/{action}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{api_base_url}/apps/annotation-reply/{action}")
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 \"score_threshold\": 0.9,\n \"embedding_provider_name\": \"openai\",\n \"embedding_model_name\": \"text-embedding-3-small\"\n}"
response = http.request(request)
puts response.read_body{
"job_id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
"job_status": "waiting"
}Authorizations
API Key 認証です。すべての API リクエストにおいて、Authorization HTTP ヘッダーに Bearer プレフィックスを付けた API Key を含めてください。例:Authorization: Bearer {API_KEY}。API Key はサーバーサイドに保存し、クライアントサイドで共有・保存しないことを強く推奨します。API Key の漏洩は深刻な結果につながる可能性があります。
Path Parameters
実行するアクションです。
Available options:
enable, disable Body
application/json
アノテーション返信設定を構成するためのリクエストボディです。
Response
200 - application/json
アノテーション返信設定タスクが開始されました。
非同期ジョブ ID です。アノテーション返信の初期設定タスクステータスを取得 と組み合わせて進捗を追跡します。
現在のジョブステータスです。waiting はキュー待ち、processing は処理中、completed は完了、error は失敗を示します。
⌘I