Documents

שיטה: corpora.documents.create

יצירת Document ריק.

נקודת קצה

פוסט https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

name string

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

גוף הבקשה

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

שדות
query string

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

resultsCount integer

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

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

שדות
relevantChunks[] object (RelevantChunk)

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

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

שיטה: corpora.documents.list

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

נקודת קצה

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

parent string

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

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

pageSize integer

זה שינוי אופציונלי. המספר המקסימלי של Documents שיוחזר (לכל דף). יכול להיות שהשירות יחזיר פחות ערכים של 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 ספציפי.

נקודת קצה

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

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/*}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

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.

נקודת קצה

מחיקה https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

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.

שדות
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.

הפורמט הזה משתמש ב-RFC 3339, שבו הפלט שנוצר תמיד יהיה מנורמלי לפי Z וישמש בספרות עשרוניות של 0, 3, 6 או 9. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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. אפשר להשתמש גם בשינויים (offsets) אחרים מלבד '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

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

שדות
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

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

שדות
values[] string

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

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