Chunks

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

יצירת Chunk.

נקודת קצה

פוסט 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.

שדות
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.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע חדש של 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

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

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

pageToken string

זה שינוי אופציונלי. אסימון דף, שהתקבל משיחה קודמת של chunks.list.

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

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

גוף הבקשה

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

גוף התשובה

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

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

שדות
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.

נקודת קצה

תיקון 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.

שדות
data object (ChunkData)

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

customMetadata[] object (CustomMetadata)

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

גוף התשובה

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

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

מחיקה של Chunk.

נקודת קצה

מחיקה 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 בקבוצה.

נקודת קצה

פוסט 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}.

גוף הבקשה

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

שדות
requests[] object (CreateChunkRequest)

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

גוף התשובה

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

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

שדות
chunks[] object (Chunk)

נוצרו Chunk.

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

CreateChunkRequest

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

שדות
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 בבת אחת.

נקודת קצה

פוסט https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

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

parent string

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

גוף הבקשה

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

שדות
requests[] object (UpdateChunkRequest)

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

גוף התשובה

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

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

שדות
chunks[] object (Chunk)

Chunk עודכנו.

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

UpdateChunkRequest

בקשה לעדכון של Chunk.

שדות
chunk object (Chunk)

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

updateMask string (FieldMask format)

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

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

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

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

מחיקת Chunk בקבוצה.

נקודת קצה

פוסט https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

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

parent string

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

גוף הבקשה

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

שדות
requests[] object (DeleteChunkRequest)

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

גוף התשובה

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

DeleteChunkRequest

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

שדות
name string

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

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

משאב REST: corpora.documents.chunks

משאב: מקטע

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

שדות
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.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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 כמחרוזת. המספר המקסימלי של אסימונים בכל מקטע הוא 2043.

ייצוג ב-JSON 
{

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

מדינה

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

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