Docuents

משאב REST: corpora.documents

משאב: מסמך

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

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
שדות
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.

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

שיטה: corpora.documents.create

הפונקציה יוצרת Document ריק.

נקודת קצה

לשלוח https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

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

parent string

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

גוף הבקשה

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

גוף התשובה

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

שיטה: corpora.documents.list

רשימה של כל Document הנכסים בCorpus.

נקודת קצה

הורדה 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.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" תנאים = [{int_value = 2020, Action = GREATER_EQUAL}, {int_value = 2010, action = LESS}}, {key = "chunk.custom_metadata.genre" תנאים = [{stringValue = "drama", action = EQUAL}, {stringValue = "action", Action = EQUAL}}]

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

MetadataFilter רשימת אובייקטים: metadataFilters = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = &quot;chunk.custom_metadata.year&quot; תנאים = [{int_value = 2020, Action = LESS_EQUAL}]}]

הערה: תווי 'AND' לאותו מפתח נתמכים רק לערכים מספריים. ערכי מחרוזת תומכים רק בסימן 'OR' (או) עבור אותו מפתח.

גוף התשובה

התשובה מאת documents.query, שמכילה רשימה של מקטעי נתונים רלוונטיים.

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

שדות
relevantChunks[] object (RelevantChunk)

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

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

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

גוף התשובה

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

גוף הבקשה

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

גוף התשובה

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

CustomMetadata

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

ייצוג 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.
}
שדות
key string

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

שדה איחוד value.

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

stringValue string

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

stringListValue object (StringList)

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

numericValue number

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

StringList

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

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

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