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)

הסוכן מבצע קריאה ל-ResolveOrder

submitOrder

object (SubmitOrder)

הסוכן ביצע קריאה ל-SubmitOrder

matchIntent

object (MatchIntent)

הסוכן ביצע קריאת 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

פלט בלבד. סוג האירוע של מכירת מוצר או שירות לא קשור (upsell).

accepted

boolean

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

TrafficType

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

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

Methods

delete

מחיקת SessionRecord.

get

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

list

הצגת רשימה של SessionRecords של מותג מסוים.