REST Resource: projects.locations.dataStores.documents

מקור מידע: מסמך

מסמך הוא יחידת תוכן אחת שמוטמעת במאגר נתונים. זהו משאב משנה של DataStore. במהלך ההטמעה, המערכת מנתחת את המסמך ומחלקת אותו לקטע אחד או יותר.

ייצוג ב-JSON 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
שדות
name

string

מזהה. שם המשאב המלא של המסמך.

פורמט: projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId}. הערך של documentId צריך להיות באורך של 1-63 תווים, ולעמוד בדרישות של RFC1035.

כשמייבאים קבצים ישירות באמצעות ImportDocuments (פורמט המקור שמוגדר כברירת מחדל), השירות מפיק את documentId מה-URI של Cloud Storage של הקובץ: ייבוא מחדש של אותו URI מעדכן את אותו מסמך, וקובץ ששמו השתנה או שהועבר הופך למסמך חדש. ב-SOURCE_FORMAT_DOCUMENT_JSON, הערך של documentId נלקח מה-name שצוין בקובץ הקלט.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה המסמך נוצר.

השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

השימוש הוא ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
content

object (Content)

זה שינוי אופציונלי. הנתונים הלא מובְנים שמקושרים למסמך הזה: הקובץ ב-Cloud Storage שממנו הוא יובא. חובה בכל שורה בקובץ קלט של SOURCE_FORMAT_DOCUMENT_JSON.
etag

string

זה שינוי אופציונלי. ה-etag של המסמך.
metadata

object (DocumentMetadata)

זה שינוי אופציונלי. מטא-נתונים שהוגדרו על ידי המשתמש למסמך הזה. ערכי המטא-נתונים חייבים להתאים ל-documentMetadataSchema שמוגדר במאגר הנתונים הראשי.

תוכן

נתונים לא מובנים שמקושרים למסמך הזה.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
שדות
התוכן של המסמך הלא מובנה. זו רשימה של שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
gcsUri

string

ה-URI של Cloud Storage של התוכן. יש תמיכה רק בכתובות URI של Cloud Storage (למשל gs://bucket-name/path/to/file).
סוף השדות שמוציאים זה את זה.

DocumentMetadata

מטא-נתונים שמוגדרים על ידי המשתמש ומשויכים למסמך.

ייצוג ב-JSON 
{
  "value": {
    object
  }
}
שדות
value

object (Struct format)

זה שינוי אופציונלי. ערך המטא-נתונים, כאובייקט JSON. הערך חייב להתאים ל-documentMetadataSchema שמוגדר ב-DataStore הראשי.

Methods

get

 מקבל מסמך.

list

 הצגת רשימת המסמכים במאגר נתונים.
חיפוש במסמכים של מאגר נתונים אחד.