REST Resource: corpora.documents.chunks

משאב: צ'אנק

Chunk הוא תת-חלק של Document שמוגדר כיחידה עצמאית למטרות ייצוג ואחסון של וקטורים. Corpus יכול להכיל עד מיליון Chunk.

ייצוג JSON 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}
שדות
name

string

לא משתנה. מזהה. שם המשאב Chunk. המזהה (לא כולל התחילית 'corpora/*/documents/*/chunks/') יכול להכיל עד 40 תווים אלפאנומריים או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, המערכת תיצור מזהה ייחודי אקראי בן 12 תווים. לדוגמה: corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c
data

object (ChunkData)

חובה. התוכן של Chunk, למשל מחרוזת הטקסט. מספר האסימונים המקסימלי לכל מקטע הוא 2043.
customMetadata[]

object (CustomMetadata)

אפשרות. מטא-נתונים מותאמים אישית שסופקו על ידי משתמשים, שמאוחסנים כצמדי מפתח/ערך. המספר המקסימלי של CustomMetadata לכל מקטע הוא 20.
createTime

string (Timestamp format)

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

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

string (Timestamp format)

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

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

enum (State)

פלט בלבד. המצב הנוכחי של Chunk.

ChunkData

נתונים חולצו שמייצגים את התוכן ב-Chunk.

ייצוג JSON 
{

  // Union field data can be only one of the following:
  "stringValue": string
  // End of list of possible types for union field data.
}
שדות

שדה איחוד data.

הערך של data יכול להיות רק אחת מהאפשרויות הבאות:
stringValue

string

התוכן Chunk כמחרוזת. מספר האסימונים המקסימלי לכל מקטע הוא 2043.

ארץ

מדינות במחזור החיים של Chunk.

טיפוסים בני מנייה (enums)
STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה משמש אם משמיטים את המצב.
STATE_PENDING_PROCESSING מתבצע עיבוד של Chunk (הטמעה ואחסון וקטורים).
STATE_ACTIVE העיבוד של Chunk הסתיים ואפשר לשלוח אליו שאילתות.
STATE_FAILED העיבוד של Chunk נכשל.

שיטות

batchCreate

 יצירת Chunk פריטים בכמות גדולה.

batchDelete

 מחיקה בכמות גדולה של Chunk שנ'.

batchUpdate

 עדכון בכמות גדולה Chunk שנ'.

create

 יוצר Chunk.

delete

 מוחק Chunk.

get

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

list

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

patch

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