REST Resource: projects.locations.collections.dataStores.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/*. השדה הזה מוגדר כשהפעולה מתחילה ומנוקה כשהיא מסתיימת.

מדינה

רשימה של מצב הסשן.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED לא צוין סטטוס.
IN_PROGRESS הסשן פתוח כרגע.

הפעלה

מייצג תור, כולל שאילתה מהמשתמש ותשובה מהשירות.

ייצוג JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  },
  "live": boolean
}
שדות
query

object (Query)

זה שינוי אופציונלי. שאילתת המשתמש. יכול להיות שההגדרה לא תוגדר אם התור הזה הוא רק יצירה מחדש של תשובה לתור אחר
answer

string

זה שינוי אופציונלי. שם המשאב של התשובה לשאילתת המשתמש.

ההגדרה הזו רלוונטית רק אם יצירת התשובה (קריאה ל-API של התשובה) התרחשה בתור הזה.
assistAnswer

string

פלט בלבד. שם המשאב של התשובה של Assistant לשאילתת המשתמש.

הערך הזה מוגדר רק אם התבצעה שיחת עזרה (קריאה ל-API של assist) בתור הזה.

פורמט: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer} כדי לקבל את כל התשובות של AssistAnswers עבור סשן, צריך להגדיר את GetSessionRequest.include_answer_details כ-true. לחלופין, כדי לקבל משאב AssistAnswer ספציפי, אפשר להשתמש ב-AssistAnswerService.GetAssistAnswer API.
detailedAnswer

object (Answer)

פלט בלבד. ב-ConversationalSearchService.GetSession API, אם GetSessionRequest.include_answer_details מוגדר כ-true, השדה הזה יאוכלס כשמתקבלת תשובה לשאילתה של סשן.
detailedAssistAnswer

object (AssistAnswer)

פלט בלבד. ב-ConversationalSearchService.GetSession API, אם GetSessionRequest.include_answer_details מוגדר כ-true, השדה הזה יאוכלס כשמקבלים הפעלה של העוזר הדיגיטלי.
queryConfig

map (key: string, value: string)

זה שינוי אופציונלי. מייצג מטא-נתונים שקשורים להגדרת השאילתה, למשל מודל LLM וגרסה שנעשה בהם שימוש, פרמטרים של המודל (טמפרטורה, פרמטרים של עיגון וכו'). התחילית google.‎ שמורה לפונקציונליות שפותחה על ידי Google.
live

boolean

זה שינוי אופציונלי. מציין אם התור הזה הוא תור חי.

Methods

create

 יוצר סשן.

delete

 מחיקת סשן.

get

 מקבלים סשן.

list

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

patch

 עדכון של סשן.