REST Resource: projects.locations.apps.assistantSessions

משאב: AssistantSession

סשן של Assistant מייצג שיחה בין משתמש לבין נציג Assistant.

ייצוג ב-JSON 
{
  "name": string,
  "requestor": string,
  "messages": [
    {
      object (AssistantMessage)
    }
  ],
  "state": enum (AssistantSessionState),
  "createTime": string,
  "updateTime": string,
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  },
  "displayName": string,
  "artifacts": [
    {
      object (AssistantSessionArtifact)
    }
  ],
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  },
  "activeTurn": {
    object (ActiveTurnInfo)
  },
  "touchedApps": [
    string
  ]
}
שדות
name

string

חובה. מזהה. המזהה הייחודי של הסשן. פורמט: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
requestor

string

פלט בלבד. המשתמש שהתחיל את הסשן.
messages[]

object (AssistantMessage)

זה שינוי אופציונלי. היסטוריית ההודעות בסשן.
state

enum (AssistantSessionState)

פלט בלבד. סטטוס הסשן של העוזר הדיגיטלי.
createTime

string (Timestamp format)

פלט בלבד. השעה שבה נוצר הסשן של Assistant.

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

string (Timestamp format)

פלט בלבד. השעה שבה הסשן של Assistant עודכן לאחרונה.

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

object (UserResponseSuggestions)

פלט בלבד. הצעות לתשובות של המשתמש מהסוכן של Assistant.
displayName

string

זה שינוי אופציונלי. השם המוצג של הסשן ב-Assistant.
artifacts[]

object (AssistantSessionArtifact)

פלט בלבד. פריטי מידע שנוצרו במסמך (למשל, מסמכי TDD שנוצרו ב-Markdown) על ידי ה-Assistant בסשן הזה. מצביעים בלבד. תוכן הקובץ נמצא בקטגוריה של הלקוח ב-Cloud Storage.
sessionCheckpoint

object (SessionCheckpoint)

פלט בלבד. נקודת בקרה של הסשן שמכילה את כוונת המשתמש (Intent) וסיכום של ההיסטוריה המתגלגלת.
activeTurn

object (ActiveTurnInfo)

פלט בלבד. פרטי הקובץ המצורף של התור שפועל כרגע בסשן הזה. לא מוגדר כשאין תור פעיל.
touchedApps[]

string

פלט בלבד. אפליקציות שהסשן הזה טירגט או שינה (סשנים ברמת הפרויקט בלבד), לתגי היסטוריה. פורמט: projects/{project}/locations/{location}/apps/{app}

AssistantMessage

הודעה בסשן של Assistant.

ייצוג ב-JSON 
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
שדות
role

string

חובה. התפקיד בשיחה: "user" (משתמש) או "model" (מודל).
chunks[]

object (AssistantChunk)

זה שינוי אופציונלי. התוכן של ההודעה בחלקים.
eventTime

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".
attachedGcsUris[]

string

זה שינוי אופציונלי. מזהי URI של Cloud Storage לקבצים שהמשתמש העלה במהלך התור הזה. כך אפשר לשמור קבצים מצורפים ולהציג אותם בממשק המשתמש של היסטוריית הסשנים. דוגמה: "gs://cxas-transient-uploads/uuid/prd.pdf"

AssistantChunk

חלק מהנתונים בהודעה של Assistant.

ייצוג ב-JSON 
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "thought": string,
  "payload": {
    object
  },
  "typedPayload": {
    object (TypedPayload)
  }
  // End of mutually exclusive fields.
}
שדות
createTime

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".
הנתונים במקטע. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
text

string

זה שינוי אופציונלי. נתוני טקסט.
thought

string

זה שינוי אופציונלי. המודל יצר את המחשבה.
payload

object (Struct format)

זה שינוי אופציונלי. מטען ייעודי (payload) שמכיל תשובות מובנות כמו דוח האיכות, שם הגרסה של הנציג, הצעות לתשובות וכו'.
typedPayload

object (TypedPayload)

זה שינוי אופציונלי. מטען ייעודי (payload) מסוג מסוים שמכיל תשובות מובְנות.
סוף השדות שמוציאים זה את זה.

TypedPayload

מטען ייעודי (payload) עם סוג. משמש את היסטוריית Assistant‏ (AssistantChunk) ואת אירוע הסטרימינג typedPayload. נמצא כאן כי גם assistant_service.proto וגם session_service.proto צריכים אותו.

ייצוג ב-JSON 
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
שדות
displayName

string

חובה. השם המוצג של המטען הייעודי (payload).
type

string

חובה. סוג המטען הייעודי (payload).
value

object (Struct format)

חובה. הערך של המטען הייעודי (payload).
metadata

object (Struct format)

זה שינוי אופציונלי. המטא-נתונים של המטען הייעודי (payload).

AssistantSessionState

סטטוס הסשן של העוזר הדיגיטלי.

טיפוסים בני מנייה (enum)
ASSISTANT_SESSION_STATE_UNSPECIFIED ערך ברירת המחדל. המערכת משתמשת בערך הזה אם הסטטוס לא צוין.
PROCESSING העוזר הדיגיטלי מעבד את הבקשה כמשימה ארוכה.
IDLE הסוכן של Assistant לא פעיל ואין לו בקשות או תשובות בהמתנה.
PENDING_REVIEW הסוכן של Assistant סיים לעבד משימה ארוכה ויש לו תשובה מוכנה למשתמש.

UserResponseSuggestions

הצעות לתשובות של המשתמש מהסוכן של Assistant.

ייצוג ב-JSON 
{
  "suggestions": [
    string
  ]
}
שדות
suggestions[]

string

חובה. ה-Assistant הציעה תשובות למשתמש. אלה הצעות למשתמשים איך ליצור אינטראקציה עם העוזר הדיגיטלי.

AssistantSessionArtifact

פריט מידע שנוצר על ידי העוזר הדיגיטלי במהלך סשן, ונשמר כקובץ בקטגוריה של Cloud Storage של הלקוח.

ייצוג ב-JSON 
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
שדות
id

string

פלט בלבד. המזהה הייחודי של פריט המידע בסשן.
displayName

string

פלט בלבד. שם הקובץ שמוצג למשתמש, למשל "hotel_booking_tdd.md".
gcsUri

string

פלט בלבד. האובייקט ב-Cloud Storage שמכיל את תוכן פריט המידע שנוצר. דוגמה: "gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md"
mimeType

string

פלט בלבד. סוג המדיה של IANA של תוכן פריט המידע שנוצר, למשל "text/markdown".
createTime

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

integer

פלט בלבד. אינדקס ההודעה ב-[AssistantSession.messages] שהתור שלה יצר את פריט המידע שנוצר על ידי AI, כדי למקם את הצ'יפ של פריט המידע שנוצר על ידי AI כשההיסטוריה משוחזרת.

SessionCheckpoint

נקודת ביקורת של הסשן שמכילה את כוונת המשתמש (Intent) המשוערת לשם הסשן ולממשק המשתמש.

ייצוג ב-JSON 
{
  "userIntent": string
}
שדות
userIntent

string

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

ActiveTurnInfo

מידע על קובץ מצורף פעיל לסשן שפועל כרגע, מנותק מהלקוח שלו או ממתין לאיסוף על ידי משימת שרת אחרת.

ייצוג ב-JSON 
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
שדות
turnId

string

מזהה את התור. מוחזר על ידי תמונות מצב של המשך ב-API לסטרימינג.
status

enum (ActiveTurnInfo.Status)

סטטוס הקובץ המצורף הנוכחי.
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".
lastProgressTime

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

string (Timestamp format)

פלט בלבד. מתי ה-turn יסתיים אם אף לקוח לא יתחבר.

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

ActiveTurnInfo.Status

איך התור הנוכחי קשור למשימות של הלקוחות והשרת.

טיפוסים בני מנייה (enum)
STATUS_UNSPECIFIED לא צוין.
RUNNING התור מתבצע עם לקוח אחד לפחות שמחובר.
DISCONNECTED התור מתבצע בלי לקוח מחובר.
RESUMING התור בהמתנה לאיסוף: הוא ימשיך בפעם הבאה שתתחברו.
ABANDONED ההשכרה של השרת של התור הסתיימה ואין משימה שמפעילה אותו. הקריאה הבאה חותמת אותו כחלקי מחויב. אי אפשר לצרף.

Methods

cancelAssistantTurn

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

create

 יצירת סשן חדש של Assistant באפליקציה הנתונה.

delete

 מחיקה של סשן Assistant שצוין.

get

 קבלת פרטים על סשן ספציפי של Assistant.

list

 רשימה של כל הסשנים של Assistant באפליקציה הנתונה.

streamChatAiAssistant

 מפעיל את Arc, העוזר האישי מבוסס-AI, בסשן העוזר האישי שצוין, במצב סטרימינג.