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

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

Methods

addContextFile

 העלאה של קובץ הקשר לשימוש כמקור לשיחות עם העוזר הדיגיטלי במהלך הסשן.

create

 יוצר סשן.

delete

 מחיקת סשן.

get

 קבלת סשן.

list

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

patch

 עדכון של סשן.