REST Resource: projects.locations.collections.engines.sessions

משאב: סשן

הגדרת פרוטו של סשן חיצוני.

ייצוג JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean,
  "pendingAsyncAssistOperationId": string
}
שדות
name

string

אי אפשר לשנות. שם ייחודי מלא projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

זה שינוי אופציונלי. השם המוצג של הסשן.

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

enum (State)

מצב הסשן.
userPseudoId

string

מזהה ייחודי למעקב אחרי משתמשים.
turns[]

object (Turn)

פניות.
labels[]

string

זה שינוי אופציונלי. התוויות של הסשן. אפשר להגדיר אותו כמסנן ב-ListSessionsRequest.
startTime

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".
endTime

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".
isPinned

boolean

זה שינוי אופציונלי. אם הסשן מוצמד, הוא יוצג בראש רשימת הסשנים.
pendingAsyncAssistOperationId

string

פלט בלבד. שם מלא של משאב של פעולת AsyncAssist בתהליך עבור הסשן הזה, לדוגמה projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*. השדה הזה מוגדר כשהפעולה מתחילה ומנוקה כשהיא מסתיימת.

Methods

addContextFile

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

create

 יוצר סשן.

delete

 מחיקת סשן.

get

 מקבלים סשן.

list

 רשימה של כל הסשנים לפי ההורה שלהם DataStore.

listSessionFileMetadata

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

patch

 עדכון של סשן.

recommendQuestions

 מקבלים הצעות לשאלות לסשן הנתון.

removeContextFile

 הפונקציה מסירה קובץ הקשר מסשן.

selectContextFiles

 בחירת קובצי הקשר לשימוש בסשן.

validateUserAuthorization

 מאמת את תהליך ההסכמה של אימות במורד הזרם (downstream) של OAuth עם 3 רגליים (3LO) מסוג A2A, אחרי שהמשתמש חוזר ממסך ההסכמה של הצד השלישי, ומסיים את פרטי הכניסה במורד הזרם באמצעות Auth Manager.