REST Resource: projects.locations.brands.sessionRecords

משאב: SessionRecord

מייצג רשומה של סשן יחיד.

ייצוג ב-JSON 
{
  "name": string,
  "sessionStartTime": string,
  "storeId": string,
  "laneId": string,
  "interactions": [
    {
      object (Interaction)
    }
  ],
  "outcomeLabel": string,
  "outcomeGroupLabel": string,
  "audioRecordingPath": string,
  "order": {
    object (Order)
  },
  "sessionDuration": string,
  "upsellAttemptRecords": [
    {
      object (UpsellAttemptRecord)
    }
  ],
  "audioRecording": string,
  "trafficType": enum (TrafficType),
  "channelType": enum (ChannelType)
}
שדות
name

string

מזהה. שם המשאב של SessionRecord. פורמט: projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{sessionRecord}
sessionStartTime

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

string

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

string

אי אפשר לשנות. המזהה של הנתיב בסשן ההזמנה.
interactions[]

object (Interaction)

פלט בלבד. שלבי השיחה.
outcomeLabel

string

פלט בלבד. תווית התוצאה הסופית של ההזמנה.
outcomeGroupLabel

string

פלט בלבד. תווית הקבוצה של התוצאה.
audioRecordingPath

string

פלט בלבד. הנתיב להקלטת האודיו המלאה.
order

object (Order)

פלט בלבד. ההזמנה שמשויכת לרשומה של הסשן.
sessionDuration

string (Duration format)

פלט בלבד. המשך הכולל של הסשן.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-s. דוגמה: "3.5s".
upsellAttemptRecords[]

object (UpsellAttemptRecord)

פלט בלבד. מכירות של מוצרים יקרים יותר שבוצעו במהלך הסשן.
audioRecording

string (bytes format)

פלט בלבד. הקלטת אודיו של הסשן. השדה הזה מאוכלס רק כשמבצעים קריאה ל-sessionRecords.get.

מחרוזת בקידוד Base64.
trafficType

enum (TrafficType)

פלט בלבד. סוג התנועה בסשן.
channelType

enum (ChannelType)

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

אינטראקציה

מייצג אינטראקציה אחת בתור בשיחה.

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

  // Union field interaction can be only one of the following:
  "userUtterance": {
    object (UserUtterance)
  },
  "agentUtterance": {
    object (AgentUtterance)
  },
  "resolveOrder": {
    object (ResolveOrder)
  },
  "submitOrder": {
    object (SubmitOrder)
  },
  "matchIntent": {
    object (MatchIntent)
  },
  "clientExecution": {
    object (ClientExecution)
  },
  "clientOrderUpdate": {
    object (ClientOrderUpdate)
  }
  // End of list of possible types for union field interaction.
}
שדות
turnPosition

string (int64 format)

פלט בלבד. לשנות את המיקום בשיחה.
שדה איחוד interaction. סוג האינטראקציה. הערך interaction יכול להיות רק אחד מהבאים:
userUtterance

object (UserUtterance)

אמירה של משתמש.
agentUtterance

object (AgentUtterance)

אמירה של נציג.
resolveOrder

object (ResolveOrder)

הסוכן מבצע שיחה לפתרון ההזמנה
submitOrder

object (SubmitOrder)

הסוכן מבצע קריאה לפונקציה SubmitOrder
matchIntent

object (MatchIntent)

הנציג ביצע שיחה עם התאמת כוונות
clientExecution

object (ClientExecution)

שיחת ClientExecution שבוצעה על ידי הנציג
clientOrderUpdate

object (ClientOrderUpdate)

עדכון סטטוס ההזמנה שמתבצע על ידי הלקוח

UserUtterance

ההבעה של המשתמש.

ייצוג ב-JSON 
{
  "text": string,
  "createTime": string
}
שדות
text

string

הטקסט של מה שהמשתמש אמר.
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".

AgentUtterance

האמירה של הנציג.

ייצוג ב-JSON 
{
  "text": string,
  "createTime": string
}
שדות
text

string

הטקסט של האמירה של הנציג.
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".

ResolveOrder

האינטראקציה של פתרון ההזמנה.

ייצוג ב-JSON 
{
  "input": {
    object (ResolveOrderInput)
  },
  "output": {
    object (ResolveOrderOutput)
  }
}
שדות
input

object (ResolveOrderInput)

הקלט לפעולה של פתרון ההזמנה.
output

object (ResolveOrderOutput)

הפלט של פעולת הטיפול בהזמנה.

ResolveOrderInput

הקלט לאינטראקציה של פתרון ההזמנה.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

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

ResolveOrderOutput

הפלט של האינטראקציה לפתרון בעיה בהזמנה.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

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

SubmitOrder

בסוג הזה אין שדות.

האינטראקציה של שליחת ההזמנה.

MatchIntent

האינטראקציה של התאמת כוונת המשתמש.

ייצוג ב-JSON 
{
  "input": {
    object (MatchIntentInput)
  },
  "output": {
    object (MatchIntentOutput)
  }
}
שדות
input

object (MatchIntentInput)

הקלט לאינטראקציה של התאמת כוונת המשתמש.
output

object (MatchIntentOutput)

הפלט של האינטראקציה של התאמת כוונת המשתמש.

MatchIntentInput

הקלט לאינטראקציה של התאמת כוונת המשתמש.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

המטען הייעודי (payload) של קלט האינטראקציה של כוונת ההתאמה.

MatchIntentOutput

הפלט של האינטראקציה של התאמת כוונת המשתמש.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

המטען הייעודי (payload) של פלט האינטראקציה של התאמת כוונות.

ClientExecution

האינטראקציה של ביצוע בצד הלקוח.

ייצוג ב-JSON 
{
  "toolName": string,
  "input": {
    object (ClientExecutionInput)
  },
  "output": {
    object (ClientExecutionOutput)
  }
}
שדות
toolName

string

שם הכלי לאינטראקציה של ביצוע בצד הלקוח.
input

object (ClientExecutionInput)

הקלט לאינטראקציה של ביצוע לקוח.
output

object (ClientExecutionOutput)

הפלט של האינטראקציה של ביצוע הלקוח.

ClientExecutionInput

הקלט לאינטראקציה של ביצוע לקוח.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

המטען הייעודי (payload) של קלט האינטראקציה של ביצוע בצד הלקוח.

ClientExecutionOutput

הפלט של האינטראקציה של ביצוע הלקוח.

ייצוג ב-JSON 
{
  "payload": {
    object
  }
}
שדות
payload

object (Struct format)

המטען הייעודי (payload) של פלט האינטראקציה של ביצוע בצד הלקוח.

ClientOrderUpdate

עדכון סטטוס ההזמנה בוצע על ידי הלקוח.

ייצוג ב-JSON 
{
  "order": {
    object (Order)
  }
}
שדות
order

object (Order)

עדכון של סטטוס ההזמנה שנשלח על ידי הלקוח.

UpsellAttemptRecord

מייצג ניסיון לשדרוג. הנתונים האלה משמשים להצגת מידע על שדרוגים בהיסטוריית ההזמנות במסוף, כלומר סוג השדרוג, מזהה התור והאם השדרוג אושר. הנתונים מאוכלסים מ-Spanner על סמך יומני רישום מעובדים.

ייצוג ב-JSON 
{
  "turnId": integer,
  "upsellType": string,
  "accepted": boolean
}
שדות
turnId

integer

פלט בלבד. מזהה התור שבו התרחשה ההזדמנות למכירת מוצר משודרג.
upsellType

string

פלט בלבד. סוג אירוע השדרוג.
accepted

boolean

פלט בלבד. האם המשתמש קיבל את ההצעה למעבר למהדורה מתקדמת יותר.

TrafficType

סוג התנועה בסשן. התווית הזו משמשת לסימון מדדי המעקב, הרישום ביומן והניראות (observability).

טיפוסים בני מנייה (enum)
TRAFFIC_TYPE_UNSPECIFIED לא צוין סוג התנועה.
EXTERNAL התנועה מגיעה מלקוח חיצוני.
INTEGRATION_TEST התנועה מגיעה מבדיקת שילוב.
EVAL התנועה מגיעה מכלי ההערכה.
PROBER התנועה מגיעה מהבודק.
MANUAL_TEST התנועה מגיעה מבדיקות ידניות.
INTERNAL_TOOL התנועה מגיעה מכלי פנימי.
CONSOLE התנועה מגיעה ממסוף ה-AI של Food.

Methods

delete

 מחיקת SessionRecord.

get

 מקבלים SessionRecord ספציפי.

list

 הפונקציה מחזירה רשימה של SessionRecords עבור מותג נתון.