Chunks

משאב REST: 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, למשל מחרוזת הטקסט. המספר המקסימלי של אסימונים לכל מקטע הוא 2,043.

customMetadata[] object (CustomMetadata)

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

createTime string (Timestamp format)

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

חותמת זמן ב-RFC3339 UTC 'Zulu' בפורמט של רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "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.

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 כמחרוזת. המספר המקסימלי של אסימונים לכל מקטע הוא 2,043.

מדינה

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

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

שיטה: 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.

גוף התשובה

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

נקודת קצה

הורדה 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.

גוף התשובה

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

ייצוג JSON 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}
שדות
parent string

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

chunk object (Chunk)

חובה. 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.

ייצוג JSON 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}
שדות
chunk object (Chunk)

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

updateMask string (FieldMask format)

חובה. רשימת השדות לעדכון. נכון לעכשיו, העדכון תומך רק בעדכון customMetadata וב-data.

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

שיטה: 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.

ייצוג JSON 
{
  "name": string
}
שדות
name string

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