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

העלאה של קובץ הקשר לשימוש כמקור לקריאות העזרה במהלך הסשן.

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}:addContextFile

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

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

פרמטרים
name

string

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

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

גוף הבקשה

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

ייצוג JSON 
{
  "fileName": string,
  "mimeType": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "fileContents": string
  // End of mutually exclusive fields.
}
שדות
fileName

string

חובה. שם הקובץ.
mimeType

string

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

השדה הזה הוא שדה חובה אם מקור הנתונים לא מספק את סוג התוכן.
התוכן של הקובץ. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
fileContents

string (bytes format)

תוכן הקובץ מוצג בתוך הטקסט.

מחרוזת בקידוד Base64.
סוף השדות הבלעדיים.

גוף התשובה

תשובה לשיטה AssistantService.AddContextFile.

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

ייצוג JSON 
{
  "session": string,
  "fileId": string,
  "tokenCount": string,
  "mimeType": string,
  "byteCount": string,
  "fileName": string
}
שדות
session

string

שם הסשן, השם שצוין או השם החדש שנוצר.

פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
fileId

string

המזהה של הקובץ שהועלה.
tokenCount
(deprecated)

string (int64 format)

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

אורך הקובץ שנמדד בטוקנים.
mimeType

string

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

בניגוד ל-AddContextFileRequest.mime_type האופציונלי שסופק על ידי המתקשר, זהו סוג התוכן שהשירות פתר בפועל עבור הקובץ.
byteCount

string (int64 format)

פלט בלבד. גודל הקובץ שהועלה בבייטים.
fileName

string

פלט בלבד. השם של הקובץ שהועלה, כולל סיומת הקובץ.

בניגוד ל-AddContextFileRequest.file_name שסופק על ידי המתקשר, השירות מוסיף את הסיומת שתואמת ל-mimeType שנפתר כשאין שם שסופק על ידי המתקשר, כך שיומני ביקורת של השימוש מתעדים את סוג הקובץ גם עבור קבצים שנוצרו על ידי AI עם שם כללי.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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.addContextFile

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