REST Resource: corpora.documents

แหล่งข้อมูล: เอกสาร

Document เป็นคอลเล็กชันของ Chunk Corpus มี Document ได้สูงสุด 10,000 รายการ

การแสดง JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
ช่อง
name

string

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

string

ไม่บังคับ ชื่อที่แสดงที่มนุษย์อ่านได้สำหรับ Document ชื่อที่แสดงต้องมีความยาวไม่เกิน 512 อักขระ รวมการเว้นวรรคด้วย ตัวอย่าง: "เอกสารประกอบเกี่ยวกับการศึกษาเรื่องเพศ"
customMetadata[]

object (CustomMetadata)

ไม่บังคับ ข้อมูลเมตาที่กําหนดเองที่ผู้ใช้ให้ไว้ซึ่งจัดเก็บเป็นคู่คีย์-ค่าที่ใช้สำหรับการค้นหา Document มี CustomMetadata ได้สูงสุด 20 รายการ
updateTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาที่ Document ได้รับการอัปเดตล่าสุด

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"
createTime

string (Timestamp format)

เอาต์พุตเท่านั้น การประทับเวลาสร้าง Document

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนได้สูงสุด 9 หลัก ตัวอย่าง: "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

วิธีการ

create

 สร้าง Document ที่ว่างเปล่า

delete

 ลบ Document

get

 รับข้อมูลเกี่ยวกับ Document ที่เฉพาะเจาะจง

list

 แสดงรายการ Document ทั้งหมดใน Corpus

patch

 อัปเดต Document

query

 ทำการค้นหาเชิงความหมายผ่าน Document