Documents

ה-API של חיפוש קבצים מפנה לקובצי המקור הגולמיים או למסמכים שלכם כאובייקטים זמניים של קבצים.

שיטה: fileSearchStores.documents.delete

מחיקת Document.

נקודת קצה

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

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

name string

חובה. שם המשאב של Document שרוצים למחוק. דוגמה: fileSearchStores/my-file-search-store-123/documents/the-doc-abc התוצאה תהיה fileSearchStores/{filesearchstore}/documents/{document}.

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

force boolean

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

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

גוף הבקשה

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

גוף התשובה

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

שיטה: fileSearchStores.documents.get

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

נקודת קצה

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

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

name string

חובה. השם של Document שרוצים לאחזר. דוגמה: fileSearchStores/my-file-search-store-123/documents/the-doc-abc התוצאה תהיה fileSearchStores/{filesearchstore}/documents/{document}.

גוף הבקשה

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

גוף התשובה

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

שיטה: fileSearchStores.documents.list

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

נקודת קצה

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

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

parent string

חובה. השם של FileSearchStore שמכיל את Document. דוגמה: fileSearchStores/my-file-search-store-123 התוצאה תהיה fileSearchStores/{filesearchstore}.

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

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
}

שיטה: fileSearchStores.documents.query

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

נקודת קצה

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

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

name string

חובה. השם של Document שאותו רוצים לשאול. דוגמה: fileSearchStores/my-file-search-store-123/documents/the-doc-abc התוצאה תהיה fileSearchStores/{filesearchstore}/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 object list: 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)
    }
  ]
}

משאב REST: ‏ fileSearchStores.documents

משאב: מסמך

Document הוא אוסף של Chunk.

Fields
name string

אי אפשר לשנות אותו. מזהה. שם המשאב Document. המזהה (השם ללא הקידומת fileSearchStores/*/documents/) יכול להכיל עד 40 תווים שהם אלפאנומריים באותיות קטנות או מקפים (-). המזהה לא יכול להתחיל או להסתיים במקף. אם השם ריק בזמן היצירה, ייגזר שם ייחודי מ-displayName יחד עם סיומת אקראית של 12 תווים. דוגמה: fileSearchStores/{file_search_store_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".

state enum (State)

פלט בלבד. המצב הנוכחי של Document.

sizeBytes string (int64 format)

פלט בלבד. גודל הבייטים הגולמיים שנקלטו במסמך.

mimeType string

פלט בלבד. סוג ה-MIME של המסמך.

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

מדינה (State)

מצבים במחזור החיים של Document.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה משמש אם לא מציינים את המצב.
STATE_PENDING חלק מChunks של Document נמצאים בתהליך עיבוד (הטמעה ואחסון וקטורים).
STATE_ACTIVE כל הנתונים Chunks של Document מעובדים וזמינים להרצת שאילתות.
STATE_FAILED העיבוד של חלק מהChunks של Document נכשל.