REST Resource: corpora.documents

משאב: מסמך

Document הוא אוסף של Chunk. Corpus יכול להכיל עד 10,000 Document.

ייצוג 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 אפשר להזין מקסימום 20 CustomMetadata.
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של מועד העדכון האחרון של Document.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של יצירת Document.

חותמת זמן בפורמט "זולו" RFC3339 UTC, ברזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

שיטות

create

 יוצר Document ריק.

delete

 מוחק Document.

get

 קבלת מידע על Document ספציפי.

list

 רשימה של כל הפריטים מסוג Document בCorpus.

patch

 מתבצע עדכון של Document.

query

 מבצע חיפוש סמנטי ב-Document.