Chunks

שיטה: corpora.documents.chunks.create

יוצר Chunk.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

פרמטרים של נתיב

parent string

חובה. השם של Document שבו ייצור Chunk. דוגמה: corpora/my-corpus-123/documents/the-doc-abc התבנית היא corpora/{corpora}/documents/{document}.

גוף הבקשה

גוף הבקשה מכיל מופע של Chunk.

Fields
name string

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

data object (ChunkData)

חובה. התוכן של התג Chunk, כמו מחרוזת הטקסט. מספר האסימונים המקסימלי בכל נתח הוא 2,043.

customMetadata[] object (CustomMetadata)

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של Chunk.

שיטה: corpora.documents.chunks.list

מציג רשימה של כל Chunk בDocument.

נקודת קצה

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

פרמטרים של נתיב

parent string

חובה. שם הDocument שמכיל את Chunk. דוגמה: corpora/my-corpus-123/documents/the-doc-abc התבנית היא corpora/{corpora}/documents/{document}.

פרמטרים של שאילתה

pageSize integer

אופציונלי. המספר המקסימלי של Chunk שיוחזרו (לכל דף). יכול להיות שהשירות יחזיר פחות מ-Chunk.

אם לא מציינים ערך, יוחזרו לכל היותר 10 Chunk. המגבלה המקסימלית היא 100 Chunk בכל דף.

pageToken string

אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של chunks.list.

כדי לאחזר את הדף הבא, צריך להזין את nextPageToken שמוחזר בתגובה כארגומנט לבקשה הבאה.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-chunks.list חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

תשובה מ-chunks.list שמכילה רשימה עם מספור עמודים של Chunk. העמודה Chunk ממוינת לפי chunk.create_time בסדר עולה.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

Fields
chunks[] object (Chunk)

הערכים Chunk שהוחזרו.

nextPageToken string

טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

ייצוג ב-JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

שיטה: corpora.documents.chunks.get

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

נקודת קצה

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

פרמטרים של נתיב

name string

חובה. השם של Chunk שרוצים לאחזר. דוגמה: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk התבנית היא corpora/{corpora}/documents/{document}/chunks/{chunk}.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Chunk.

שיטה: corpora.documents.chunks.patch

מעדכן את Chunk.

נקודת קצה

patch https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

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

פרמטרים של נתיב

chunk.name string

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

פרמטרים של שאילתה

updateMask string (FieldMask format)

חובה. רשימת השדות לעדכון. בשלב הזה, אפשר לעדכן רק את customMetadata ואת data.

זוהי רשימה של שמות שדות שמוגדרים במלואם, שמופרדים באמצעות פסיקים. דוגמה: "user.displayName,photo"

גוף הבקשה

גוף הבקשה מכיל מופע של Chunk.

Fields
data object (ChunkData)

חובה. התוכן של התג Chunk, כמו מחרוזת הטקסט. מספר האסימונים המקסימלי בכל נתח הוא 2,043.

customMetadata[] object (CustomMetadata)

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

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Chunk.

שיטה: corpora.documents.chunks.delete

מחיקת Chunk.

נקודת קצה

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

פרמטרים של נתיב

name string

חובה. שם המשאב של Chunk שרוצים למחוק. דוגמה: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk התבנית היא corpora/{corpora}/documents/{document}/chunks/{chunk}.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.

שיטה: corpora.documents.chunks.batchCreate

יצירת קבוצה של Chunk קודים.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

פרמטרים של נתיב

parent string

אופציונלי. השם של Document שבו ייווצר האצווה הזו של Chunk. השדה ברמת ההורה בכל תג CreateChunkRequest חייב להיות זהה לערך הזה. דוגמה: corpora/my-corpus-123/documents/the-doc-abc התבנית היא corpora/{corpora}/documents/{document}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

Fields
requests[] object (CreateChunkRequest)

חובה. הודעות הבקשה שמציינות את Chunk שצריך ליצור. אפשר ליצור עד 100 Chunks באצווה.

גוף התשובה

תשובה מ-chunks.batchCreate שמכילה רשימה של Chunk שנוצרו.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

Fields
chunks[] object (Chunk)

נוצרו Chunk.

ייצוג ב-JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

בקשה ליצירת Chunk.

Fields
parent string

חובה. השם של Document שבו ייצור Chunk. דוגמה: corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

חובה. לוחצים על Chunk כדי ליצור.

ייצוג ב-JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

שיטה: corpora.documents.chunks.batchUpdate

עדכון של כמה Chunk בבת אחת.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

פרמטרים של נתיב

parent string

אופציונלי. השם של Document שמכיל את Chunks שרוצים לעדכן. השדה ברמת ההורה בכל תג UpdateChunkRequest חייב להיות זהה לערך הזה. דוגמה: corpora/my-corpus-123/documents/the-doc-abc התבנית היא corpora/{corpora}/documents/{document}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

Fields
requests[] object (UpdateChunkRequest)

חובה. הודעות הבקשה שמציינות את Chunk שצריך לעדכן. אפשר לעדכן עד 100 Chunks בבת אחת.

גוף התשובה

תגובה מ-chunks.batchUpdate שמכילה רשימה של Chunk מעודכנים.

אם הפעולה מצליחה, גוף התגובה מכיל נתונים במבנה הבא:

Fields
chunks[] object (Chunk)

הפרטים של Chunk עודכנו.

ייצוג ב-JSON 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

בקשה לעדכן את Chunk.

Fields
chunk object (Chunk)

חובה. הגרסה של Chunk שצריך לעדכן.

updateMask string (FieldMask format)

חובה. רשימת השדות לעדכון. בשלב הזה, אפשר לעדכן רק את customMetadata ואת data.

זוהי רשימה של שמות שדות שמוגדרים במלואם, שמופרדים באמצעות פסיקים. דוגמה: "user.displayName,photo"

ייצוג ב-JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

שיטה: corpora.documents.chunks.batchDelete

מחיקת Chunks בכמות גדולה.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

פרמטרים של נתיב

parent string

אופציונלי. שם Document שמכיל את Chunks שרוצים למחוק. השדה ברמת ההורה בכל תג DeleteChunkRequest חייב להיות זהה לערך הזה. דוגמה: corpora/my-corpus-123/documents/the-doc-abc התבנית היא corpora/{corpora}/documents/{document}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

Fields
requests[] object (DeleteChunkRequest)

חובה. ההודעות עם הבקשה שמציינות את Chunk שרוצים למחוק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה הוא אובייקט JSON ריק.

DeleteChunkRequest

בקשה למחיקה של Chunk.

Fields
name string

חובה. שם המשאב של Chunk שרוצים למחוק. לדוגמה: corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

ייצוג ב-JSON 
{
  "name": string
}

משאב REST: ‏ corpora.documents.chunks

משאב: Chunk

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

Fields
name string

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

data object (ChunkData)

חובה. התוכן של התג Chunk, כמו מחרוזת הטקסט. מספר האסימונים המקסימלי בכל נתח הוא 2,043.

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

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

הפלט שנוצר תמיד יהיה בפורמט 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)

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

הפלט שנוצר תמיד יהיה בפורמט 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".

state enum (State)

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

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

ChunkData

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

שדות
data Union type
הערך data יכול להיות רק אחד מהבאים:
stringValue string

התוכן של Chunk כמחרוזת. מספר האסימונים המקסימלי בכל נתח הוא 2,043.

ייצוג ב-JSON 
{

  // data
  "stringValue": string
  // Union type
}

מדינה

מצבים במחזור החיים של Chunk.

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