שיטה: corpora.documents.create
הפונקציה יוצרת Document
ריק.
נקודת קצה
פוסט
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
פרמטרים של נתיב
parent
string
חובה. השם של ה-Corpus
שבו הDocument
ייווצר. לדוגמה: corpora/my-corpus-123
היא מופיעה בצורה corpora/{corpora}
.
גוף הבקשה
גוף הבקשה מכיל מופע של Document
.
name
string
בלתי ניתן לשינוי. מזהה. שם המשאב Document
. המזהה (השם, לא כולל הקידומת corpora/*/documents/) יכול להכיל עד 40 תווים אלפאנומריים באותיות קטנות או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, המערכת תיצור שם ייחודי מ-displayName
עם סיומת אקראית באורך 12 תווים. דוגמה: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
זה שינוי אופציונלי. השם המוצג של ה-Document
, שקריא לבני אדם. אורך השם לתצוגה חייב להיות עד 512 תווים, כולל רווחים. דוגמה: "מסמכי התיעוד של Semantic Retriever"
customMetadata[]
object (CustomMetadata
)
זה שינוי אופציונלי. מטא-נתונים מותאמים אישית שהמשתמשים סיפקו, שמאוחסנים כצמדי מפתח/ערך ומשמשים לשליחת שאילתות. השדה Document
יכול להכיל עד 20 CustomMetadata
.
גוף התשובה
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע חדש של Document
.
שיטה: corpora.documents.query
ביצוע חיפוש סמנטי ב-Document
.
נקודת קצה
פוסט
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
פרמטרים של נתיב
name
string
חובה. השם של Document
לשליחת השאילתה. דוגמה: corpora/my-corpus-123/documents/the-doc-abc
הוא בפורמט corpora/{corpora}/documents/{document}
.
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
query
string
חובה. מחרוזת השאילתה לביצוע חיפוש סמנטי.
resultsCount
integer
זה שינוי אופציונלי. המספר המקסימלי של Chunk
s שיוחזר. השירות עשוי להחזיר פחות 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
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" תנאים = [{int_value = 2020, Action = GREATER_EQUAL}, {int_value = 2010, action = LESS}}, {key = "chunk.custom_metadata.genre" conditions = [{stringValue = "drama", operation = EQUAL}, {stringValue = "action", operation = EQUAL}}]
שאילתה לדוגמה לטווח מספרי של ערכים: (שנה > AND שנה > 2015 <= 2020)
MetadataFilter
object list: metadataFilters = [ {key = "chunk.custom_metadata.year" תנאים = [{int_value = 2015, Action = GREATER}]}, {key = "chunk.custom_metadata.year" תנאים = [{int_value = 2020, Action = LESS_EQUAL}]}]
הערה: תווי 'AND' לאותו מפתח נתמכים רק בערכים מספריים. בערכים של מחרוזות יש תמיכה רק בתנאי 'OR' לאותו מפתח.
גוף התשובה
התשובה מאת documents.query
, שמכילה רשימה של מקטעי נתונים רלוונטיים.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
relevantChunks[]
object (RelevantChunk
)
הקטעים הרלוונטיים שהוחזרו.
ייצוג JSON |
---|
{
"relevantChunks": [
{
object ( |
שיטה: 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 Document
לכל דף.
pageToken
string
זה שינוי אופציונלי. אסימון דף, שהתקבל משיחה קודמת של documents.list
.
כדי לאחזר את הדף הבא, מציינים את הערך של nextPageToken
שהוחזר בתגובה כארגומנטים לבקשה הבאה.
כשמחלקים את הדפים, כל הפרמטרים האחרים שסופקו ל-documents.list
חייבים להתאים לקריאה שסיפקה את אסימון הדף.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תשובה מאת documents.list
, עם רשימה ממוספרת של Document
. ערכי Document
ממוינים לפי document.create_time
בסדר עולה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:
documents[]
object (Document
)
הערכים מסוג 'Document
' שהוחזרו.
nextPageToken
string
אסימון, שניתן לשלוח בתור pageToken
כדי לאחזר את הדף הבא. אם השדה הזה יושמט, אין דפים נוספים.
ייצוג ב-JSON |
---|
{
"documents": [
{
object ( |
שיטה: 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
.
נקודת קצה
תיקון
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
.
displayName
string
זה שינוי אופציונלי. השם המוצג של ה-Document
, שקריא לבני אדם. השם המוצג יכול להיות באורך של 512 תווים לכל היותר, כולל רווחים. דוגמה: 'מסמכי תיעוד סמנטיים'
customMetadata[]
object (CustomMetadata
)
זה שינוי אופציונלי. מטא-נתונים מותאמים אישית שהמשתמשים סיפקו, שמאוחסנים כצמדי מפתח/ערך ומשמשים לשליחת שאילתות. השדה Document
יכול להכיל עד 20 CustomMetadata
.
גוף התשובה
אם הפעולה מצליחה, גוף התגובה מכיל מופע של Document
.
שיטה: corpora.documents.delete
מחיקה של Document
.
נקודת קצה
מחיקה
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
.
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
אם הביצוע יהיה תקין, גוף התגובה יהיה ריק.
משאב REST: corpora.documents
משאב: מסמך
Document
הוא אוסף של Chunk
. Corpus
יכול להכיל עד 10,000 Document
.
name
string
בלתי ניתן לשינוי. מזהה. שם המשאב Document
. המזהה (שם, לא כולל התחילית 'corpora/*/documents/') יכול להכיל עד 40 תווים אלפאנומריים או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם יהיה ריק בזמן היצירה, המערכת תיצור שם ייחודי מ-displayName
יחד עם סיומת אקראית בת 12 תווים. דוגמה: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
זה שינוי אופציונלי. השם המוצג של ה-Document
, שקריא לבני אדם. אורך השם לתצוגה חייב להיות עד 512 תווים, כולל רווחים. דוגמה: "מסמכי התיעוד של Semantic Retriever"
customMetadata[]
object (CustomMetadata
)
זה שינוי אופציונלי. מטא-נתונים מותאמים אישית שהמשתמשים סיפקו, שמאוחסנים כצמדי מפתח/ערך ומשמשים לשליחת שאילתות. השדה Document
יכול להכיל עד 20 CustomMetadata
.
updateTime
string (Timestamp
format)
פלט בלבד. חותמת הזמן של מועד העדכון האחרון של Document
.
חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z"
ו-"2014-10-02T15:01:23.045123456Z"
.
createTime
string (Timestamp
format)
פלט בלבד. חותמת הזמן של מועד היצירה של Document
.
חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z"
ו-"2014-10-02T15:01:23.045123456Z"
.
ייצוג JSON |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
CustomMetadata
מטא-נתונים שהמשתמשים סיפקו, שמאוחסנים כצמדי מפתח-ערך.
key
string
חובה. המפתח של המטא-נתונים לשמירה.
שדה האיחוד value
.
הערך של value
יכול להיות רק אחת מהאפשרויות הבאות:
stringValue
string
ערך המחרוזת של המטא-נתונים לשמירה.
stringListValue
object (StringList
)
הערך של StringList של המטא-נתונים שרוצים לשמור.
numericValue
number
הערך המספרי של המטא-נתונים לשמירה.
ייצוג ב-JSON |
---|
{ "key": string, // Union field |
StringList
ערכי המחרוזת שהמשתמשים סיפקו מוקצים למפתח מטא-נתונים יחיד.
values[]
string
ערכי המחרוזות של המטא-נתונים שרוצים לאחסן.
ייצוג JSON |
---|
{ "values": [ string ] } |