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.

נקודת קצה

הורדה 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 בסדר עולה.

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

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

גוף הבקשה

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

גוף התשובה

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

שיטה: 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 שצריך למחוק.

גוף התשובה

אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.

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.

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

updateTime string (Timestamp format)

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

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

state enum (State)

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

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

ChunkData

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

שדות

שדה האיחוד data.

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

stringValue string

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

ייצוג JSON 
{

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

מדינה

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

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