Documents

שיטה: corpora.documents.create

יוצרת Document ריקה.

נקודת קצה

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

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

parent string

חובה. השם של Corpus שבו ייצור Document. דוגמה: corpora/my-corpus-123 התבנית היא corpora/{corpora}.

גוף הבקשה

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

Fields
name string

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

displayName string

אופציונלי. השם המוצג של Document שקריא לבני אדם. אורך השם המוצג מוגבל ל-512 תווים, כולל רווחים. דוגמה: "Semantic Retriever Documentation"

customMetadata[] object (CustomMetadata)

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

גוף התשובה

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

שיטה: corpora.documents.query

מבצע חיפוש סמנטי ב-Document.

נקודת קצה

post https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query

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

name string

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

גוף הבקשה

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

Fields
query string

חובה. מחרוזת שאילתה לביצוע חיפוש סמנטי.

resultsCount integer

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

אם לא מציינים ערך, יוחזרו לכל היותר 10 Chunk. המספר המקסימלי של התוצאות שניתן לציין הוא 100.

metadataFilters[] object (MetadataFilter)

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

הערה: סינון ברמה Document לא נתמך בבקשה הזו כי כבר צוין שם של Document.

שאילתה לדוגמה: (year >= 2020 OR year < 2010) AND (genre = drama OR genre = action)

MetadataFilter רשימת אובייקטים: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = GREATER_EQUAL}, {int_value = 2010, operation = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]

שאילתה לדוגמה לטווח מספרי של ערכים: (year > 2015 AND year <= 2020)

‫MetadataFilter object list: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" conditions = [{int_value = 2020, operation = LESS_EQUAL}]}]

הערה: אפשר להשתמש ב-AND לאותו מפתח רק עם ערכים מספריים. ערכי מחרוזת תומכים רק ב-OR לאותו מפתח.

גוף התשובה

תשובה מ-documents.query שמכילה רשימה של נתחים רלוונטיים.

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

Fields
relevantChunks[] object (RelevantChunk)

החלקים הרלוונטיים שמוחזרים.

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

שיטה: corpora.documents.list

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

נקודת קצה

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

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

parent string

חובה. שם הCorpus שמכיל את Document. דוגמה: corpora/my-corpus-123 התבנית היא corpora/{corpora}.

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

pageSize integer

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

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

pageToken string

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

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

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

גוף הבקשה

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

גוף התשובה

תשובה מ-documents.list שמכילה רשימה עם מספור עמודים של Document. העמודה Document ממוינת לפי document.create_time בסדר עולה.

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

Fields
documents[] object (Document)

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

nextPageToken string

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

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

שיטה: corpora.documents.get

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

נקודת קצה

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

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

name string

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

גוף הבקשה

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

גוף התשובה

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

שיטה: corpora.documents.patch

מעדכן את Document.

נקודת קצה

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

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

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

document.name string

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

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

updateMask string (FieldMask format)

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

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

גוף הבקשה

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

Fields
displayName string

אופציונלי. השם המוצג של Document שקריא לבני אדם. אורך השם המוצג מוגבל ל-512 תווים, כולל רווחים. דוגמה: "Semantic Retriever Documentation"

customMetadata[] object (CustomMetadata)

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

גוף התשובה

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

שיטה: corpora.documents.delete

מחיקת Document.

נקודת קצה

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

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

name string

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

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

force boolean

אופציונלי. אם הערך מוגדר כ-true, גם כל הChunk והאובייקטים שקשורים לDocument הזה יימחקו.

אם הערך הוא False (ברירת המחדל), תוחזר שגיאת FAILED_PRECONDITION אם Document מכיל ערכים מסוג Chunk.

גוף הבקשה

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

גוף התשובה

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

משאב REST: ‏ corpora.documents

משאב: מסמך

Document הוא אוסף של Chunk. בCorpus יכולים להיות עד 10,000 Document.

Fields
name string

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

displayName string

אופציונלי. השם המוצג של Document שקריא לבני אדם. אורך השם המוצג מוגבל ל-512 תווים, כולל רווחים. דוגמה: "Semantic Retriever Documentation"

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

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

createTime string (Timestamp format)

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

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

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}

CustomMetadata

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

Fields
key string

חובה. המפתח של המטא-נתונים שרוצים לאחסן.

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

ערך המחרוזת של המטא-נתונים שרוצים לאחסן.

stringListValue object (StringList)

ערך ה-StringList של המטא-נתונים שרוצים לאחסן.

numericValue number

הערך המספרי של המטא-נתונים שרוצים לאחסן.

ייצוג ב-JSON 
{
  "key": string,

  // value
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // Union type
}

StringList

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

Fields
values[] string

ערכי המחרוזת של המטא-נתונים שרוצים לאחסן.

ייצוג ב-JSON 
{
  "values": [
    string
  ]
}