Documents

שיטה: 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 תווים, כולל רווחים. דוגמה: 'מסמכי תיעוד סמנטיים'

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 שניות שצריך להחזיר. יכול להיות שהשירות יחזיר פחות ערכים של Chunk.

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

metadataFilters[] object (MetadataFilter)

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

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

שאילתה לדוגמה: (שנה >= 2020 OR שנה < 2010) AND (ז'אנר = דרמה OR ז'אנר = פעולה)

רשימת אובייקטים של 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 = &quot;chunk.custom_metadata.year&quot; תנאים = [{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 (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 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 (Document)
    }
  ],
  "nextPageToken": string
}

שיטה: corpora.documents.get

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

נקודת קצה

הורדה 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 תווים, כולל רווחים. דוגמה: "מסמכי התיעוד של Semantic Retriever"

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.

גוף הבקשה

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

גוף התשובה

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

משאב 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 תווים, כולל רווחים. דוגמה: 'מסמכי תיעוד סמנטיים'

customMetadata[] object (CustomMetadata)

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

updateTime string (Timestamp format)

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

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

CustomMetadata

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

שדות
key string

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

שדה האיחוד value.

הערך של value יכול להיות רק אחת מהאפשרויות הבאות:

stringValue string

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

stringListValue object (StringList)

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

numericValue number

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

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

  // Union field value can be only one of the following:
  "stringValue": string,
  "stringListValue": {
    object (StringList)
  },
  "numericValue": number
  // End of list of possible types for union field value.
}

StringList

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

שדות
values[] string

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

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