แก้ไขฟิลด์ข้อมูลเมตา

แก้ไขฟิลด์ข้อมูลเมตาแบบเป็นชุด โดยแก้ไขได้เฉพาะ display_label, description และ ai_search_filter ระบบจะอัปเดตเฉพาะค่าที่ระบุ ส่วนค่าที่ไม่ได้ระบุจะคงเดิม คำขอหนึ่งครั้งแก้ไขได้สูงสุด 50 ฟิลด์

กฎแบทช์:
สามารถแก้ไขได้สูงสุด 50 รายการในคราวเดียว และทั้งชุดจะไม่ได้รับการประมวลผลหากเกิน 50 รายการ
หากมี id ซ้ำกันในคำขอ ระบบจะประมวลผลเฉพาะรายการแรก ส่วนรายการที่ซ้ำถัดไปจะล้มเหลว

เมธอดคำขอ

PUT

Endpoint

https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update

การยืนยันตัวตน

ดูรายละเอียดการยืนยันตัวตนได้ที่ ภาพรวม API

คำขอ

ตัวอย่างคำขอ

curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \ -H 'Authorization: Bearer ${API Key}' \ -H 'Content-Type: application/json' \ -d '{ "fields": [ { "id": "665f1c8a9b2e4d001a3f0001", "display_label": "หมวดหมู่เอกสาร", "description": "หมวดหมู่ธุรกิจของเอกสาร", "ai_search_filter": false } ] }'

                      
                      curl -X PUT 'https://api-${endpoint}.gptbots.ai/v1/bot/doc/metadata/field/update' \
-H 'Authorization: Bearer ${API Key}' \
-H 'Content-Type: application/json' \
-d '{
    "fields": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "display_label": "หมวดหมู่เอกสาร",
            "description": "หมวดหมู่ธุรกิจของเอกสาร",
            "ai_search_filter": false
        }
    ]
}'

บล็อกโค้ดนี้ในหน้าต่างลอย

ส่วนหัวคำขอ

ฟิลด์	ประเภท	คำอธิบาย
Authorization	Bearer ${API Key}	ยืนยันตัวตนด้วย `Authorization: Bearer ${API Key}` และรับ API Key ได้จากหน้าคีย์ API
Content-Type	application/json	ชนิดข้อมูล ตั้งค่าเป็น `application/json`

พารามิเตอร์คำขอ

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
fields	Array<Object>	ใช่	รายการช่องที่ต้องแก้ไข สูงสุด 50 ช่องในแต่ละครั้ง
id	String	ใช่	ID ของฟิลด์ข้อมูลเมตาที่ใช้ระบุฟิลด์
display_label	String	ไม่	ชื่อที่แสดงใหม่ สูงสุด 64 อักขระ ระบบจะแก้ไขเมื่อระบุค่าเท่านั้น
description	String	ไม่	คำอธิบายฟิลด์ใหม่ สูงสุด 50 อักขระ ระบบจะแก้ไขเมื่อระบุค่าเท่านั้น
ai_search_filter	Boolean	ไม่	ค่าใหม่สำหรับตัวกรอง AI Search ระบบจะแก้ไขเมื่อระบุค่าเท่านั้น

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "success_count": 1, "failure_count": 2, "results": [ { "id": "665f1c8a9b2e4d001a3f0001", "success": true }, { "id": "665f1c8a9b2e4d001a3f0002", "success": false, "error_message": "display_label already exists" }, { "id": "665f1c8a9b2e4d001a3f0001", "success": false, "error_message": "duplicate id in request" } ] }

                      
                      {
    "success_count": 1,
    "failure_count": 2,
    "results": [
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": true
        },
        {
            "id": "665f1c8a9b2e4d001a3f0002",
            "success": false,
            "error_message": "display_label already exists"
        },
        {
            "id": "665f1c8a9b2e4d001a3f0001",
            "success": false,
            "error_message": "duplicate id in request"
        }
    ]
}

บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบกลับเมื่อสำเร็จ

ฟิลด์	ประเภท	คำอธิบาย
success_count	Integer	จำนวนฟิลด์ที่แก้ไขสำเร็จ
failure_count	Integer	จำนวนฟิลด์ที่ไม่สามารถแก้ไขได้
results	Array<Object>	ผลลัพธ์แบบฟิลด์ต่อฟิลด์ ส่งคืนตามลำดับคำขอ
id	String	ID ของฟิลด์
success	Boolean	ระบุว่าแก้ไขสำเร็จหรือไม่
error_message	String	สาเหตุของความล้มเหลว: display_label already exists (ชื่อที่แสดงขัดแย้งกับชื่อที่มีอยู่) / duplicate id in request (id ซ้ำในคำขอ) / field not found (ไม่มีฟิลด์นี้)

การตอบกลับเมื่อเกิดข้อผิดพลาด

ฟิลด์	ประเภท	คำอธิบาย
code	Integer	รหัสข้อผิดพลาด
message	String	รายละเอียดข้อผิดพลาด