Method: projects.locations.collections.engines.sessions.listSessionFileMetadata

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

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:listSessionFileMetadata

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

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

פרמטרים
name

string

חובה. שם המשאב של הסשן. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה AssistantService.ListSessionFileMetadata.

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

ייצוג ב-JSON 
{
  "fileMetadata": [
    {
      object (FileMetadata)
    }
  ],
  "totalQuotaPercentage": number
}
שדות
fileMetadata[]

object (FileMetadata)

‫FileMetadata שנ'.
totalQuotaPercentage
(deprecated)

number

הוצא משימוש: יכול להיות שהשדה הזה לא מוגדר, או שהערך לא מתייחס לכל סוגי הקבצים. מיועדת להסרה.

אחוז מכסת האחסון הכוללת שמשמשת את כל הקבצים.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.sessions.listSessionFileMetadata

מידע נוסף מופיע במאמרי העזרה בנושא IAM.

FileMetadata

המטא-נתונים של הקובץ.

ייצוג ב-JSON 
{
  "fileId": string,
  "name": string,
  "mimeType": string,
  "byteSize": string,
  "tokenCount": string,
  "quotaPercentage": number,
  "selected": boolean,
  "usedInConversation": boolean,
  "originalUri": string,
  "originalSourceType": enum (FileSource),
  "uploadTime": string,
  "metadata": {
    string: string,
    ...
  },
  "session": string
}
שדות
fileId

string

המזהה של הקובץ.
name

string

שם הקובץ שהועלה.
mimeType

string

סוג התוכן של הקובץ, אפשר לעיין בכתובת https://www.iana.org/assignments/media-types/media-types.xhtml.
byteSize

string (int64 format)

גודל קובץ ההקשר בבייטים.
tokenCount
(deprecated)

string (int64 format)

הוצא משימוש: השדה הזה לא יוגדר לכל סוגי הקבצים, ובסופו של דבר הוא יוסר.

אורך הקובץ שנמדד בטוקנים.
quotaPercentage
(deprecated)

number

הוצא משימוש: השדה הזה לא יוגדר לכל סוגי הקבצים, ובסופו של דבר הוא יוסר.

אחוז המכסה שהקובץ תופס.
selected

boolean

אם הקובץ נבחר לשימוש.
usedInConversation

boolean

האם הקובץ שימש בסשן בעבר (כלומר, שימש בשאילתה) והוא חלק מהיסטוריית השיחות, או שהוא רק הועלה ולא נעשה בו שימוש עדיין.
originalUri

string

זה שינוי אופציונלי. המיקום המקורי של הקובץ. יכול להיות שזה נתיב קובץ מקומי, או כל URI אחר שמאפשר גישה לקובץ במערכת חיצונית. יש שני תרחישים שבהם כתובת ה-URL הזו עשויה להיות ריקה: 1. אם הקובץ נשלח כנתונים מוטבעים (למשל, אם הוא הודבק מלוח העריכה). 2. אם המיקום המקורי לא זמין.

שימו לב: אין ערובה לכך שכתובת ה-URI תצביע על קובץ תקין או על קובץ שקיים בפועל. לדוגמה, יכול להיות שקובץ הועלה לסשן ואז נמחק מהמקור המקורי.
originalSourceType

enum (FileSource)

זה שינוי אופציונלי. סוג המקור המקורי של הקובץ.
uploadTime

string (Timestamp format)

פלט בלבד. השעה שבה הקובץ הועלה (אם מדובר בקובץ שנוצר על ידי תהליך פנימי ואז הועמד לרשות הסשן, השעה הזו מציינת את הרגע שבו זה קרה).

הפורמט הוא 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".
metadata

map (key: string, value: string)

זה שינוי אופציונלי. מייצג מטא-נתונים שקשורים לקובץ, שיכולים להתאים לתרחישי שימוש מסוימים. התחילית google. שמורה למפתח לשימוש על ידי Google, אבל אפשר להשתמש בחופשיות בתחיליות אחרות.
session

string

פלט בלבד. שם המשאב של הסשן. פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}

FileSource

המקור המקורי של הקובץ.

טיפוסים בני מנייה (enum)
FILE_SOURCE_UNSPECIFIED ערך ברירת המחדל. מקורות לא מוכרים.
FILE_SOURCE_INLINE הנתונים של הקובץ סופקו בשורה (לדוגמה, הודבקו מלוח העריכה).
FILE_SOURCE_LOCAL הקובץ הועלה מקובץ מקומי.
FILE_SOURCE_CLOUD_STORAGE הקובץ הועלה מ-Cloud Storage.
FILE_SOURCE_CLOUD_DRIVE הקובץ הועלה מ-Drive.
FILE_SOURCE_URL הקובץ אוחזר מכתובת URL (למשל, מהאינטרנט הציבורי).