Method: corpora.documents.patch

อัปเดต Document

คำขอ HTTP

PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}

URL ใช้ไวยากรณ์การแปลง gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
document.name

string

เปลี่ยนแปลงไม่ได้ ตัวระบุ ชื่อทรัพยากร Document รหัส (ชื่อที่ไม่มีคำนำหน้า "corpora/*/documents/") ต้องประกอบด้วยอักขระที่เป็นตัวอักษรพิมพ์เล็กและตัวเลขคละกันหรือขีดกลาง (-) ได้สูงสุด 40 ตัว รหัสขึ้นต้นหรือลงท้ายด้วยขีดกลางไม่ได้ หากชื่อว่างเปล่าขณะสร้าง ชื่อที่ไม่ซ้ำกันจะได้มาจาก displayName พร้อมกับคำต่อท้ายแบบสุ่มจำนวน 12 อักขระ ตัวอย่าง: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

พารามิเตอร์การค้นหา

พารามิเตอร์
updateMask

string (FieldMask format)

ต้องระบุ รายการช่องที่จะอัปเดต ปัจจุบันรองรับเฉพาะการอัปเดต displayName และ customMetadata เท่านั้น

ซึ่งเป็นรายการชื่อฟิลด์ที่คั่นด้วยคอมมา ตัวอย่าง: "user.displayName,photo"

เนื้อหาของคำขอ

เนื้อความของคำขอมีอินสแตนซ์ของ Document

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีอินสแตนซ์ Document

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/generative-language.retriever

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวมการตรวจสอบสิทธิ์