כלי: update_evaluation
מעדכן את ההערכה שצוינה. חשוב להקפיד להעביר תמיד מסכת עדכון בקלט.
בדוגמת הקוד הבאה מוסבר איך להשתמש ב-curl כדי להפעיל את כלי ה-MCP update_evaluation.
| בקשת Curl |
|---|
curl --location 'https://ces.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "update_evaluation", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
הודעת בקשה עבור EvaluationService.UpdateEvaluation.
UpdateEvaluationRequest
| ייצוג ב-JSON |
|---|
{
"evaluation": {
object ( |
| שדות | |
|---|---|
evaluation |
חובה. ההערכה שרוצים לעדכן. |
updateMask |
זה שינוי אופציונלי. מסכת השדות משמשת כדי לקבוע אילו שדות יעודכנו. אם המסכה לא קיימת, כל השדות יעודכנו. זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: |
הערכה
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "tags": [ string ], "evaluationDatasets": [ string ], "createTime": string, "createdBy": string, "updateTime": string, "lastUpdatedBy": string, "evaluationRuns": [ string ], "etag": string, "aggregatedMetrics": { object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של ההערכה הזו. פורמט: |
displayName |
חובה. השם המוצג של ההערכה, שמוגדר על ידי המשתמש. ייחודי באפליקציה. |
description |
זה שינוי אופציונלי. תיאור של ההערכה שמוגדר על ידי המשתמש. |
tags[] |
זה שינוי אופציונלי. תגים שהמשתמשים מגדירים כדי לסווג את ההערכה. |
evaluationDatasets[] |
פלט בלבד. רשימת מערכי הנתונים להערכה שההערכה שייכת אליהם. פורמט: |
createTime |
פלט בלבד. חותמת הזמן של יצירת ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
createdBy |
פלט בלבד. המשתמש שיצר את ההערכה. |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
lastUpdatedBy |
פלט בלבד. המשתמש שעדכן לאחרונה את ההערכה. |
evaluationRuns[] |
פלט בלבד. ה-EvaluationRuns שההערכה הזו משויכת אליהם. |
etag |
פלט בלבד. Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
aggregatedMetrics |
פלט בלבד. המדדים המצטברים של ההערכה הזו בכל ההרצות. |
lastCompletedResult |
פלט בלבד. תוצאת ההערכה האחרונה של ההערכה הזו. |
invalid |
פלט בלבד. האם ההערכה לא תקינה. זה יכול לקרות אם הערכה מפנה לכלי, לערכת כלים או לסוכן שנמחקו מאז. |
lastTenResults[] |
פלט בלבד. 10 תוצאות ההערכה האחרונות של ההערכה הזו. השדה הזה מאוכלס רק אם include_last_ten_results מוגדר כ-true ב-ListEvaluationsRequest או ב-GetEvaluationRequest. |
evaluationMetricsThresholdOverride |
זה שינוי אופציונלי. ההגדרה הזו מבטלת את ערכי הסף של המדדים בהערכה הספציפית הזו. |
evaluationMetricsConfigOverride |
זה שינוי אופציונלי. ההגדרה הזו מבטלת את הגדרת המדדים להערכה הספציפית הזו. |
שדה של איחוד inputs. הקלט להערכה inputs יכול להיות רק אחד מהבאים: |
|
golden |
זה שינוי אופציונלי. השלבים העיקריים שצריך לבדוק. |
scenario |
זה שינוי אופציונלי. ההגדרות של התרחיש. |
זהוב
| ייצוג ב-JSON |
|---|
{
"turns": [
{
object ( |
| שדות | |
|---|---|
turns[] |
חובה. התורות המוזהבים שנדרשים כדי להפעיל מחדש שיחה מוזהבת. המספר המקסימלי של סבבים הוא 100. |
evaluationExpectations[] |
זה שינוי אופציונלי. הציפיות מההערכה שלפיהן תתבצע הערכה של השיחה שהופעלה מחדש. פורמט: |
GoldenTurn
| ייצוג ב-JSON |
|---|
{ "steps": [ { object ( |
| שדות | |
|---|---|
steps[] |
חובה. השלבים שצריך לבצע כדי להפעיל מחדש שיחה מוצלחת. |
rootSpan |
זה שינוי אופציונלי. היחידה הלוגית הבסיסית למעקב של תור הזהב לעיבוד ולתחזוקה של מידע קולי. ה-URI של האודיו חייב להכיל אודיו שנשמר בתדירות דגימה של 16Khz. |
turnLevelMetricsThresholdsOverride |
זה שינוי אופציונלי. שינוי ערכי הסף של המדדים ברמת הפנייה. |
hallucinationMetricBehaviorOverride |
זה שינוי אופציונלי. שינוי ברירת המחדל של התנהגות המדד "הזיות" ברמת התור. |
שלב
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד step. השלב שצריך לבצע. הערך step יכול להיות רק אחד מהבאים: |
|
userInput |
זה שינוי אופציונלי. קלט של משתמשים לשיחה. |
agentTransfer |
זה שינוי אופציונלי. להעביר את השיחה לנציג אחר. |
expectation |
זה שינוי אופציונלי. מבצעת ציפייה בתור הנוכחי. |
SessionInput
| ייצוג ב-JSON |
|---|
{ "willContinue": boolean, "recordingControl": enum ( |
| שדות | |
|---|---|
willContinue |
זה שינוי אופציונלי. דגל שמציין אם ההודעה הנוכחית היא חלק מקלט גדול יותר בסשן הסטרימינג הדו-כיווני. כשהערך הוא הערה: השדה הזה לא רלוונטי לקלט של אודיו ו-DTMF, כי הם תמיד מעובדים באופן אוטומטי על סמך האות של סיום הדיבור. |
recordingControl |
זה שינוי אופציונלי. אם השיחה עשויה להיות מוקלטת ומתועדת מכאן והלאה. השתמשו באפשרות הזו כשהאפליקציה, ולא הנציג, מחליטה מה אפשר לשמור: לדוגמה, כשמשתמש הקצה צריך להסכים להקלטה לפני שאפשר לשמור מידע כלשהו על השיחה. הערך נשאר בתוקף עד שהלקוח שולח ערך אחר, כך שצריך לשלוח אותו רק כשהתשובה משתנה. ההגדרות שפועלות כששלב בשיחה מסתיים קובעות מה יקרה בשלב הזה – אם האודיו שלו יגיע לקטגוריית ההקלטות ואם התמליל שלו יגיע להיסטוריית השיחות, ל-BigQuery ול-Cloud Logging. הוא כולל את הצד של הנציג וגם את הצד של משתמש הקצה. סבבים שמסתיימים לפני שהלקוח שולח את השדה הזה בפעם הראשונה מתועדים בהתאם להגדרות הרישום ביומן של האפליקציה, כאילו השדה לא קיים. אם יותר מקלט אחד באותה בקשה מגדיר את זה, הקלט האחרון הוא זה שקובע. |
שדה של איחוד input_type. סוג הקלט. הערך input_type יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט ממשתמש הקצה. |
dtmf |
זה שינוי אופציונלי. ספרות DTMF ממשתמש הקצה. |
audio |
זה שינוי אופציונלי. נתוני אודיו ממשתמש הקצה. מחרוזת בקידוד Base64. |
toolResponses |
זה שינוי אופציונלי. תוצאות ההפעלה של קריאות ה-API לכלי מהלקוח. |
image |
זה שינוי אופציונלי. נתוני תמונה ממשתמש הקצה. |
blob |
זה שינוי אופציונלי. נתוני Blob ממשתמש הקצה. |
variables |
זה שינוי אופציונלי. משתנים לפי הקשר של הסשן, עם מפתח לפי שם. סוכן ה-CES ישתמש רק במשתנים שהוגדרו באפליקציה. משתנים לא מזוהים עדיין יישלחו אל [Dialogflow agent][Agent.RemoteDialogflowAgent] כפרמטרים נוספים של סשן. |
event |
זה שינוי אופציונלי. קלט של אירוע. |
ToolResponses
| ייצוג ב-JSON |
|---|
{
"toolResponses": [
{
object ( |
| שדות | |
|---|---|
toolResponses[] |
זה שינוי אופציונלי. רשימת התוצאות של הרצת הכלי. |
ToolResponse
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט של אובייקט JSON. צריך להשתמש במפתח output כדי לציין את התגובה של הכלי, ובמפתח error כדי לציין את פרטי השגיאה (אם יש). אם המפתחות "output" ו-"error" לא צוינו, כל ה-"response" נחשב לתוצאת ההפעלה של הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שהכלי שהופעל טירגט; משקפת את |
שדה של איחוד tool_identifier. המזהה של הכלי שהופעל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי שהופעל מתוך ערכת הכלים. |
ToolsetTool
| ייצוג ב-JSON |
|---|
{ "toolset": string, "toolId": string } |
| שדות | |
|---|---|
toolset |
חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: |
toolId |
זה שינוי אופציונלי. מזהה הכלי שלפיו מסננים את הכלים כדי לאחזר את הסכימה שלהם. |
Struct
| ייצוג ב-JSON |
|---|
{ "fields": { string: value, ... } } |
| שדות | |
|---|---|
fields |
מפה לא מסודרת של ערכים שהוקלדו באופן דינמי. אובייקט שמכיל רשימה של צמדי |
FieldsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": value } |
| שדות | |
|---|---|
key |
|
value |
|
ערך
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים: |
|
nullValue |
מייצג |
numberValue |
מייצג מספר ב-JSON. אסור להשתמש בערכים |
stringValue |
מייצג מחרוזת JSON. |
boolValue |
מייצג ערך בוליאני של JSON (ליטרל |
structValue |
מייצג אובייקט JSON. |
listValue |
מייצג מערך JSON. |
ListValue
| ייצוג ב-JSON |
|---|
{ "values": [ value ] } |
| שדות | |
|---|---|
values[] |
שדה חוזר של ערכים שהוקלדו באופן דינמי. |
תמונה
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string, "altText": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp |
data |
חובה. בייטים גולמיים של התמונה. מחרוזת בקידוד Base64. |
altText |
זה שינוי אופציונלי. הטקסט החלופי של התמונה. |
כתם
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. |
data |
חובה. בייטים גולמיים של ה-blob. מחרוזת בקידוד Base64. |
אירוע
| ייצוג ב-JSON |
|---|
{ "event": string, "variables": { object } } |
| שדות | |
|---|---|
event |
חובה. שם האירוע. |
variables |
זה שינוי אופציונלי. משתנים נוספים שמשויכים לאירוע. |
AgentTransfer
| ייצוג ב-JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| שדות | |
|---|---|
targetAgent |
חובה. הנציג שאליו מועברת השיחה. הנציג יטפל בשיחה מכאן והלאה. פורמט: |
displayName |
פלט בלבד. השם המוצג של הנציג. |
GoldenExpectation
| ייצוג ב-JSON |
|---|
{ "note": string, "skipEvaluation": boolean, "expectationLevelMetricsThresholdsOverride": { object ( |
| שדות | |
|---|---|
note |
זה שינוי אופציונלי. הערה לגבי הדרישה הזו, שימושית לדיווח כשבדיקות ספציפיות נכשלות. למשל, "Check_Payment_Tool_Called". |
skipEvaluation |
זה שינוי אופציונלי. אם המאפיין מוגדר בתור true, הציפייה הספציפית הזו לא תיבדק. |
expectationLevelMetricsThresholdsOverride |
זה שינוי אופציונלי. המדיניות הזו מבטלת את המדדים ברמת השלב. |
agentResponseSemanticSimilarityMetricsConfigOverride |
זה שינוי אופציונלי. שינויים במדדי הדמיון הסמנטי של agent_response. |
agentResponseHallucinationMetricsConfigOverride |
זה שינוי אופציונלי. שינויים במדדי ההזיה של agent_response. |
comparisonType |
זה שינוי אופציונלי. סוג ההשוואה שבה משתמשים לבדיקת הציפייה. |
שדה של איחוד condition. הבדיקה בפועל שצריך לבצע. הערך condition יכול להיות רק אחד מהבאים: |
|
toolCall |
זה שינוי אופציונלי. בודקים אם כלי ספציפי הופעל עם הפרמטרים. |
toolResponse |
זה שינוי אופציונלי. לבדוק אם כלי מסוים הגיב כמו שציפיתם. |
agentResponse |
זה שינוי אופציונלי. בודקים שהנציג השיב את התשובה הנכונה. התפקיד "סוכן" משתמע. |
agentTransfer |
זה שינוי אופציונלי. מוודאים שהנציג העביר את השיחה לנציג אחר. |
updatedVariables |
זה שינוי אופציונלי. בודקים שהנציג עדכן את משתני הסשן לערכים הצפויים. משמש גם כדי לתעד עדכונים של משתני סוכן להערכות זהב. |
mockToolResponse |
זה שינוי אופציונלי. תגובת הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
noToolCalls |
זה שינוי אופציונלי. מוודאים שלא הופעלו כלים במהלך התור הזה. |
ToolCall
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת ה-API לכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם ב- |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. הפרמטרים והערכים של הקלט לכלי בפורמט של אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שאליה השיחה הזו מיועדת, נגזרת על ידי Assistant מהארגומנטים של המשאבים של השיחה: שם משאב של אפליקציה, |
שדה של איחוד tool_identifier. המזהה של הכלי שצריך להפעיל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי להרצה מתוך ערכת הכלים. |
הודעה
| ייצוג ב-JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| שדות | |
|---|---|
role |
זה שינוי אופציונלי. התפקיד בשיחה, למשל: משתמש, נציג. |
chunks[] |
זה שינוי אופציונלי. תוכן ההודעה כסדרה של קטעים. |
eventTime |
זה שינוי אופציונלי. חותמת הזמן של שליחת או קבלת ההודעה. אין להשתמש אם ההודעה היא חלק מ- הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
מקטע
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד data. נתוני המקטע. הערך data יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט. |
transcript |
זה שינוי אופציונלי. תמליל שמשויך לאודיו. |
blob |
זה שינוי אופציונלי. נתוני Blob. |
payload |
זה שינוי אופציונלי. נתוני מטען ייעודי (payload) בהתאמה אישית. |
image |
זה שינוי אופציונלי. נתוני התמונה. |
toolCall |
זה שינוי אופציונלי. בקשה להפעלת כלי. |
toolResponse |
זה שינוי אופציונלי. תגובה להרצת הכלי. |
agentTransfer |
זה שינוי אופציונלי. אירוע העברה של סוכן. |
updatedVariables |
מבנה שמייצג משתנים שעודכנו בשיחה, עם מפתחות לפי שמות המשתנים. |
defaultVariables |
מבנה שמייצג משתני ברירת מחדל בתחילת השיחה, עם מפתחות לפי שמות המשתנים. |
חותמת הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
מייצג שניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) 1970-01-01T00:00:00Z. הערך חייב להיות בין -62135596800 ל-253402300799, כולל (טווח שמתאים ל-0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z). |
nanos |
שברים לא שליליים של שנייה ברזולוציה של ננו-שנייה. השדה הזה הוא החלק של הננו-שניות במשך הזמן, ולא חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שנספרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. |
ExpectationLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד הערך |
|
toolInvocationParameterCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה לתקינות של פרמטר קריאה לכלי ספציפי. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
SemanticSimilarityMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableSemanticSimilarityMetrics": boolean } |
| שדות | |
|---|---|
enableSemanticSimilarityMetrics |
זה שינוי אופציונלי. אם לחשב מדדי דמיון סמנטי להערכה. |
HallucinationMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableHallucinationMetrics": boolean } |
| שדות | |
|---|---|
enableHallucinationMetrics |
זה שינוי אופציונלי. אם לחשב מדדי הזיה להערכה. |
Span
| ייצוג ב-JSON |
|---|
{
"name": string,
"startTime": string,
"endTime": string,
"duration": string,
"attributes": {
object
},
"childSpans": [
{
object ( |
| שדות | |
|---|---|
name |
פלט בלבד. שם ה-span. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
duration |
פלט בלבד. משך הזמן של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
attributes |
פלט בלבד. מאפייני מפתח/ערך שמשויכים ל-span. |
childSpans[] |
פלט בלבד. ה-spans המשניים שמוטמעים ב-span הזה. |
משך
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
שניות חתומות של משך הזמן. הערך חייב להיות בין -315,576,000,000 ל-+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים |
nanos |
שברים חתומים של שנייה ברזולוציה של ננו-שנייה של משך הזמן. משכי זמן של פחות משנייה מיוצגים על ידי שדה |
TurnLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| שדות | |
|---|---|
semanticSimilarityChannel |
זה שינוי אופציונלי. ערוץ הדמיון הסמנטי שבו משתמשים להערכה. |
שדה של איחוד הערך |
|
semanticSimilaritySuccessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדמיון הסמנטי. הערך חייב להיות מספר שלם בין 0 ל-4. ברירת המחדל היא >= 3. |
שדה של איחוד הערך |
|
overallToolInvocationCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדיוק הכולל בהפעלת הכלים. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
תרחיש
| ייצוג ב-JSON |
|---|
{ "task": string, "userFacts": [ { object ( |
| שדות | |
|---|---|
task |
חובה. המשימה שהתרחיש מטרגט. |
userFacts[] |
זה שינוי אופציונלי. העובדות על המשתמשים שבהן התרחיש ישתמש. |
maxTurns |
זה שינוי אופציונלי. מספר התורות המקסימלי לסימולציה. הערך המקסימלי המותר הוא 100. ערך ברירת המחדל הוא 100. |
rubrics[] |
חובה. הקריטריונים להערכת התרחיש. |
scenarioExpectations[] |
חובה. ה-ScenarioExpectations להערכת השיחה שנוצרה על ידי סימולציית המשתמש. |
variableOverrides |
זה שינוי אופציונלי. משתנים או פרמטרים של סשן כהקשר לסשן, עם מפתחות לפי שמות המשתנים. האיברים של המבנה הזה יבטלו את ערכי ברירת המחדל שהוגדרו על ידי המערכת. חשוב לשים לב שהן שונות מעובדות של המשתמש, שהן עובדות שהמשתמש יודע. משתנים הם פרמטרים שהנציג מכיר: למשל, MDN (מספר טלפון) שמועבר על ידי מערכת הטלפוניה. |
taskCompletionBehavior |
זה שינוי אופציונלי. הוצאה משימוש, במקום זאת, צריך להשתמש ב-user_goal_behavior. |
userGoalBehavior |
זה שינוי אופציונלי. ההתנהגות הצפויה של יעד המשתמש. |
evaluationExpectations[] |
זה שינוי אופציונלי. הציפיות מההערכה שלפיהן תתבצע הערכת השיחה שנוצרה בסימולציה. פורמט: |
milestones[] |
זה שינוי אופציונלי. אבני הדרך בתרחיש הזה. |
scenarioExecutionMode |
זה שינוי אופציונלי. מצב ההפעלה של הערכות התרחישים. |
UserFact
| ייצוג ב-JSON |
|---|
{ "name": string, "value": string } |
| שדות | |
|---|---|
name |
חובה. השם של עובדת המשתמש. |
value |
חובה. הערך של העובדה על המשתמש. |
ScenarioExpectation
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד expectation. הציפייה להערכת השיחה שנוצרה על ידי הסימולציה. הערך expectation יכול להיות רק אחד מהבאים: |
|
toolExpectation |
זה שינוי אופציונלי. צמד קריאת ה-API לכלי והתשובה שרוצים להעריך. |
agentResponse |
זה שינוי אופציונלי. תשובת הנציג שצריך להעריך. |
ToolExpectation
| ייצוג ב-JSON |
|---|
{ "expectedToolCall": { object ( |
| שדות | |
|---|---|
expectedToolCall |
חובה. קריאת ה-API לכלי שצפויה להתבצע, עם הפרמטרים הרלוונטיים. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
mockToolResponse |
חובה. תגובת הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
אבן דרך
| ייצוג ב-JSON |
|---|
{
"goal": string,
"maxTurnCount": integer,
"successCriteria": string,
"protocol": string,
"staticUtterance": string,
"event": {
object ( |
| שדות | |
|---|---|
goal |
חובה. המטרה של אבן הדרך. |
maxTurnCount |
זה שינוי אופציונלי. מספר הפניות המקסימלי לאבן הדרך הזו. |
successCriteria |
זה שינוי אופציונלי. הקריטריונים להצלחה של אבן הדרך. |
protocol |
זה שינוי אופציונלי. ההנחיות שהנציג צריך לפעול לפיהן במהלך השיחה. |
staticUtterance |
זה שינוי אופציונלי. ביטוי סטטי שהסימולטור ישלח בדיוק כמו שהוא, במקום ליצור קלט משתמש באופן דינמי. |
event |
זה שינוי אופציונלי. קלט של אירוע שיישלח במקום יצירה דינמית. |
AggregatedMetrics
| ייצוג ב-JSON |
|---|
{
"metricsByAppVersion": [
{
object ( |
| שדות | |
|---|---|
metricsByAppVersion[] |
פלט בלבד. מדדים נצברים, מקובצים לפי מזהה גרסת האפליקציה. |
MetricsByAppVersion
| ייצוג ב-JSON |
|---|
{ "appVersionId": string, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
appVersionId |
פלט בלבד. מזהה גרסת האפליקציה. |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בגרסה הזו של האפליקציה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בגרסת האפליקציה הזו. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיות בגרסת האפליקציה הזו. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאות API לכלים בגרסה הזו של האפליקציה. |
turnLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של התור בגרסת האפליקציה הזו. |
passCount |
פלט בלבד. מספר הפעמים שהבדיקה עברה בהצלחה. |
failCount |
פלט בלבד. מספר הפעמים שההערכה נכשלה. |
metricsByTurn[] |
פלט בלבד. מדדים שנצברו לכל תור בגרסה הזו של האפליקציה. |
ToolMetrics
| ייצוג ב-JSON |
|---|
{ "tool": string, "passCount": integer, "failCount": integer } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי. |
passCount |
פלט בלבד. מספר הפעמים שהכלי עבר את הבדיקה. |
failCount |
פלט בלבד. מספר הפעמים שהכלי נכשל. |
SemanticSimilarityMetrics
| ייצוג ב-JSON |
|---|
{ "score": number } |
| שדות | |
|---|---|
score |
פלט בלבד. הציון הממוצע של הדמיון הסמנטי (0-4). |
HallucinationMetrics
| ייצוג ב-JSON |
|---|
{ "score": number } |
| שדות | |
|---|---|
score |
פלט בלבד. ציון ההזיה הממוצע (0 עד 1). |
ToolCallLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "tool": string, "averageLatency": string } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי. |
averageLatency |
פלט בלבד. זמן האחזור הממוצע של קריאות ה-API לכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
TurnLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "averageLatency": string } |
| שדות | |
|---|---|
averageLatency |
פלט בלבד. זמן האחזור הממוצע של התורות. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricsByTurn
| ייצוג ב-JSON |
|---|
{ "turnIndex": integer, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
turnIndex |
פלט בלבד. אינדקס התור (החל מ-0). |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בתור הזה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בתוך החלק הזה בשיחה. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיה בתור הזה. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאת ה-API לכלי במהלך הסבב הזה. |
turnLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של התור הזה. |
EvaluationResult
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "createTime": string, "evaluationStatus": enum ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של תוצאת ההערכה. פורמט: |
displayName |
חובה. השם המוצג של תוצאת ההערכה. ייחודי בתוך הערכה. כברירת מחדל, הפורמט הוא: " |
createTime |
פלט בלבד. חותמת הזמן של יצירת תוצאת ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
evaluationStatus |
פלט בלבד. תוצאת הבדיקה. השדה הזה מאוכלס רק אם הערך של execution_state הוא COMPLETE. |
evaluationRun |
פלט בלבד. הרצת ההערכה שהפיקה את התוצאה הזו. פורמט: |
persona |
פלט בלבד. הפרסונה ששימשה ליצירת השיחה לתוצאת ההערכה. |
errorInfo |
פלט בלבד. פרטי השגיאה של תוצאת ההערכה. |
error |
פלט בלבד. הוצא משימוש: צריך להשתמש ב- |
initiatedBy |
פלט בלבד. המשתמש שהפעיל את הרצת ההערכה שהובילה לתוצאה הזו. |
appVersion |
פלט בלבד. גרסת האפליקציה שבה נוצרה השיחה שהובילה לתוצאה הזו. פורמט: |
appVersionDisplayName |
פלט בלבד. השם המוצג של ה- |
changelog |
פלט בלבד. יומן השינויים של גרסת האפליקציה שבה בוצעה ההערכה. השדה הזה מאוכלס אם המשתמש מריץ הערכה על הגרסה האחרונה או על טיוטה. |
changelogCreateTime |
פלט בלבד. זמן היצירה של יומן השינויים של גרסת האפליקציה שההערכה בוצעה לגביה. השדה הזה מאוכלס אם המשתמש מריץ הערכה על הגרסה האחרונה או על טיוטה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionState |
פלט בלבד. מצב הביצוע של תוצאת ההערכה. |
evaluationMetricsThresholds |
פלט בלבד. סף ההערכה של התוצאה. |
config |
פלט בלבד. ההגדרות ששימשו להרצת ההערכה שהובילה לתוצאה הזו. |
goldenRunMethod |
פלט בלבד. השיטה שבה משתמשים כדי להריץ את הערכת הזהב. |
rootSpan |
פלט בלבד. היחידה הלוגית הבסיסית למעקב של הרצת ההערכה, שכוללת מידע על כל שלב בהערכה. |
outcomeMetadata |
פלט בלבד. המטא-נתונים של תוצאת ההערכה. השדה הזה מאוכלס רק אם הערך של execution_state הוא COMPLETE. |
שדה של איחוד result. תוצאת הבדיקה. השדה הזה מאוכלס רק כשערך השדה execution_state הוא COMPLETED. הערך result יכול להיות רק אחד מהבאים: |
|
goldenResult |
פלט בלבד. התוצאה של הערכת הזהב. |
scenarioResult |
פלט בלבד. התוצאה של הערכת התרחיש. |
GoldenResult
| ייצוג ב-JSON |
|---|
{ "turnReplayResults": [ { object ( |
| שדות | |
|---|---|
turnReplayResults[] |
פלט בלבד. התוצאה של הרצת כל שלב בשיחה האידיאלית. |
evaluationExpectationResults[] |
פלט בלבד. תוצאות הציפיות מההערכה. |
TurnReplayResult
| ייצוג ב-JSON |
|---|
{ "conversation": string, "expectationOutcome": [ { object ( |
| שדות | |
|---|---|
conversation |
פלט בלבד. השיחה שנוצרה בסבב הזה. |
expectationOutcome[] |
פלט בלבד. התוצאה של כל ציפייה. |
hallucinationResult |
פלט בלבד. תוצאת הבדיקה של ההזיות. |
toolInvocationScore |
פלט בלבד. הוצאה משימוש, במקום זאת, צריך להשתמש ב-OverallToolInvocationResult. |
turnLatency |
פלט בלבד. משך הזמן של הפנייה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
toolCallLatencies[] |
פלט בלבד. זמן האחזור של כל קריאת API לכלי בסבב. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
overallToolInvocationResult |
פלט בלבד. התוצאה של הבדיקה הכוללת של הפעלת הכלי. |
errorInfo |
פלט בלבד. מידע על השגיאה שהתרחשה במהלך התור הזה. |
spanLatencies[] |
פלט בלבד. זמן האחזור של קטעי הטקסט בתור. |
שדה של איחוד הערך |
|
toolOrderedInvocationScore |
פלט בלבד. הציון הכולל של הפעלת הכלים לפי הסדר בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים מהתור הצפוי שהופעלו בפועל בסדר הצפוי. |
GoldenExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של הציפייה. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
toolInvocationResult |
פלט בלבד. התוצאה של בדיקת הפעלת הכלי. |
שדה של איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. התוצאה של הציפייה לקריאת API לכלי. |
observedToolResponse |
פלט בלבד. התוצאה של הציפייה לתגובה מהכלי. |
observedAgentResponse |
פלט בלבד. התוצאה של הציפייה לתגובה מהסוכן. |
observedAgentTransfer |
פלט בלבד. התוצאה של הציפייה להעברה לנציג. |
observedPayload |
פלט בלבד. מטען ייעודי (payload) מותאם אישית שנצפה. אין ציפיות לגבי מטען ייעודי (payload) מותאם אישית. הנתון הזה משמש רק לחישוב מדדים. התוצאה היא תמיד SKIPPED. |
SemanticSimilarityResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, "outcome": enum ( |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 4: עקביות מלאה, ציון 3: עקביות ברוב המקרים, ציון 2: עקביות חלקית (השמטות קלות), ציון 1: חוסר עקביות ברוב המקרים (השמטות משמעותיות), ציון 0: חוסר עקביות מוחלט או סתירה |
explanation |
פלט בלבד. ההסבר לציון הדמיון הסמנטי. |
outcome |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. ההחלטה מתקבלת על סמך השוואה בין הציון לבין semantic_similarity_success_threshold. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון הדמיון הסמנטי. הערך יכול להיות 0, 1, 2, 3 או 4. |
ToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. כדי לקבוע את זה, המערכת משווה את הערך של parameter_correctness_score לסף. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
explanation |
פלט בלבד. הסבר בטקסט חופשי על התוצאה של הפעלת הכלי. |
שדה של איחוד הערך |
|
parameterCorrectnessScore |
פלט בלבד. הציון של נכונות הפרמטרים להפעלת הכלי. המדד הזה מציין את אחוז הפרמטרים מקריאת ה-API הצפויה לכלי שהיו קיימים גם בקריאת ה-API בפועל לכלי. |
HallucinationResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 1: מוצדק, ציון 0: לא מוצדק, ציון 1-: אין טענה שצריך להעריך |
explanation |
פלט בלבד. ההסבר לציון ההזיה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון ההזיה. יכול להיות -1, 0, 1. |
ToolCallLatency
| ייצוג ב-JSON |
|---|
{ "tool": string, "displayName": string, "startTime": string, "endTime": string, "executionLatency": string } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי שהופעל. פורמט: |
displayName |
פלט בלבד. השם המוצג של הכלי. |
startTime |
פלט בלבד. שעת ההתחלה של הרצת קריאת ה-API לכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הפעלת קריאת ה-API לכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionLatency |
פלט בלבד. זמן האחזור של הפעלת קריאת ה-API לכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
OverallToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. הציון נקבע על ידי השוואה בין tool_invocation_score לבין overall_tool_invocation_correctness_threshold. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
שדה של איחוד הערך |
|
toolInvocationScore |
הציון הכולל של הפעלת הכלים בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים שהופעלו בפועל מתוך הכלים שהיו צפויים לפעול בתור. |
EvaluationErrorInfo
| ייצוג ב-JSON |
|---|
{
"errorType": enum ( |
| שדות | |
|---|---|
errorType |
פלט בלבד. סוג השגיאה. |
errorMessage |
פלט בלבד. הודעת השגיאה. |
sessionId |
פלט בלבד. מזהה הסשן של השיחה שגרמה לשגיאה. |
userFacingErrorMessage |
פלט בלבד. הודעת השגיאה שמוצגת למשתמש. |
SpanLatency
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
פלט בלבד. סוג ה-span. |
displayName |
פלט בלבד. השם המוצג של ה-span. רלוונטי לטווחים של כלים ומעקות בטיחות. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionLatency |
פלט בלבד. זמן האחזור של ה-span. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
שדה של איחוד identifier. המזהה של הפריט הספציפי, בהתאם לסוג שלו. הערך identifier יכול להיות רק אחד מהבאים: |
|
resource |
פלט בלבד. שם המשאב של טווחי ההנחיות או הכלים. |
toolset |
פלט בלבד. מזהה הכלי של ערכת הכלים. |
model |
פלט בלבד. שם ה-span של ה-LLM. |
callback |
פלט בלבד. השם של טווח הקריאה החוזרת (callback) של המשתמש. |
EvaluationExpectationResult
| ייצוג ב-JSON |
|---|
{
"evaluationExpectation": string,
"prompt": string,
"outcome": enum ( |
| שדות | |
|---|---|
evaluationExpectation |
פלט בלבד. הציפייה מההערכה. פורמט: |
prompt |
פלט בלבד. ההנחיה ששימשה להערכה. |
outcome |
פלט בלבד. התוצאה של ציפיית ההערכה. |
explanation |
פלט בלבד. ההסבר לתוצאה. |
ScenarioResult
| ייצוג ב-JSON |
|---|
{ "conversation": string, "task": string, "userFacts": [ { object ( |
| שדות | |
|---|---|
conversation |
פלט בלבד. השיחה שנוצרה בתרחיש. |
task |
פלט בלבד. המשימה ששימשה להפעלת התרחיש של התוצאה הזו. |
userFacts[] |
פלט בלבד. העובדות על המשתמש ששימשו את התרחיש לתוצאה הזו. |
expectationOutcomes[] |
פלט בלבד. התוצאה של כל ציפייה. |
rubricOutcomes[] |
פלט בלבד. התוצאה של הקריטריונים להערכה. |
hallucinationResult[] |
פלט בלבד. תוצאת הבדיקה של ההזיות. לכל שלב בשיחה תהיה תוצאת הזיה אחת. |
taskCompletionResult |
פלט בלבד. התוצאה של בדיקת השלמת המשימה. |
toolCallLatencies[] |
פלט בלבד. זמן האחזור של כל הפעלה של קריאת API לכלי בשיחה. |
userGoalSatisfactionResult |
פלט בלבד. התוצאה של בדיקת שביעות הרצון של המשתמש מהיעד. |
spanLatencies[] |
פלט בלבד. זמן האחזור של הטווחים בשיחה. |
evaluationExpectationResults[] |
פלט בלבד. תוצאות הציפיות מההערכה. |
milestoneResults[] |
פלט בלבד. התוצאות של כל ציון דרך בתרחיש. |
שדה של איחוד הערך |
|
allExpectationsSatisfied |
פלט בלבד. אם כל הציפיות נענו בתור הזה. |
שדה של איחוד הערך |
|
taskCompleted |
פלט בלבד. אם המשימה הושלמה בתור הזה. הציון הזה משקלל את כל הציפיות שנענו, את היעדר ההזיות ואת שביעות הרצון של המשתמש מהשגת המטרה. |
ScenarioExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של ScenarioExpectation. |
שדה של איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. קריאת ה-API לכלי שנצפתה. |
observedAgentResponse |
פלט בלבד. התשובה של הסוכן שנצפתה. |
ObservedToolCall
| ייצוג ב-JSON |
|---|
{ "toolCall": { object ( |
| שדות | |
|---|---|
toolCall |
פלט בלבד. קריאת ה-API לכלי שנצפתה. |
toolResponse |
פלט בלבד. התשובה שנצפתה מהכלי. |
ScenarioRubricOutcome
| ייצוג ב-JSON |
|---|
{ "rubric": string, "scoreExplanation": string, // Union field |
| שדות | |
|---|---|
rubric |
פלט בלבד. הקריטריונים ששימשו להערכת השיחה. |
scoreExplanation |
פלט בלבד. התשובה של הבודק לקריטריון ההערכה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. הציון של השיחה לפי קריטריון ההערכה. |
TaskCompletionResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 1: המשימה הושלמה, ציון 0: המשימה לא הושלמה, ציון 1-: יעד המשתמש לא מוגדר |
explanation |
פלט בלבד. ההסבר לציון השלמת המשימה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון השלמת המשימה. יכול להיות -1, 0, 1 |
UserGoalSatisfactionResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 2: העברה חלקה, ציון 1: המשימה של המשתמש בוצעה, ציון 0: המשימה של המשתמש לא בוצעה, ציון 1-: המשימה של המשתמש לא צוינה |
explanation |
פלט בלבד. ההסבר לציון שביעות הרצון של המשתמשים מהמשימה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון שביעות הרצון של המשתמש מהמשימה. יכול להיות -1, 0, 1, 2. |
MilestoneResult
| ייצוג ב-JSON |
|---|
{ "milestone": { object ( |
| שדות | |
|---|---|
milestone |
פלט בלבד. אבן הדרך שאחריה מתבצע מעקב. |
status |
פלט בלבד. הסטטוס הנוכחי של אבן הדרך. |
justification |
פלט בלבד. הסיבה לסטטוס הנוכחי. |
EvaluationPersona
| ייצוג ב-JSON |
|---|
{
"name": string,
"description": string,
"displayName": string,
"personality": string,
"speechConfig": {
object ( |
| שדות | |
|---|---|
name |
חובה. המזהה הייחודי של הפרסונה. פורמט: |
description |
זה שינוי אופציונלי. תיאור הפרסונה. |
displayName |
חובה. השם המוצג של הדמות. ייחודי באפליקציה. |
personality |
חובה. הוראה לסוכן לגבי אופן ההתנהגות בהערכה. |
speechConfig |
זה שינוי אופציונלי. הגדרות הקול של הפרסונה (הגדרות TTS). |
SpeechConfig
| ייצוג ב-JSON |
|---|
{
"speakingRate": number,
"environment": enum ( |
| שדות | |
|---|---|
speakingRate |
זה שינוי אופציונלי. קצב הדיבור. 1.0 הוא הערך הרגיל. ערך נמוך יותר הוא איטי יותר (למשל, 0.8), ערך גבוה יותר הוא מהיר יותר (למשל, 1.5). התכונה הזו שימושית כדי לבדוק איך הסוכן מתמודד עם אנשים שמדברים מהר. |
environment |
זה שינוי אופציונלי. סביבת האודיו המדומה. |
voiceId |
זה שינוי אופציונלי. המזהה הספציפי של הקול או המבטא שבו ייעשה שימוש. דוגמה: "en-US-Wavenet-D" או "en-GB-Standard-A" |
סטטוס
| ייצוג ב-JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| שדות | |
|---|---|
code |
קוד הסטטוס, שצריך להיות ערך enum של |
message |
הודעת שגיאה שמיועדת למפתחים, וצריכה להיות באנגלית. כל הודעת שגיאה שגלויה למשתמשים צריכה להיות מותאמת לשוק המקומי ולהישלח בשדה |
details[] |
רשימת הודעות עם פרטי השגיאה. יש קבוצה נפוצה של סוגי הודעות לשימוש בממשקי API. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף, |
הכול
| ייצוג ב-JSON |
|---|
{ "typeUrl": string, "value": string } |
| שדות | |
|---|---|
typeUrl |
מזהה את הסוג של הודעת Protobuf שעברה סריאליזציה באמצעות הפניה ל-URI שמורכבת מתחילית שמסתיימת בלוכסן ומשם הסוג המלא. דוגמה: type.googleapis.com/google.protobuf.StringValue המחרוזת הזו חייבת להכיל לפחות תו הקידומת היא שרירותית, וההטמעות של Protobuf אמורות פשוט להסיר את כל מה שמופיע עד ל- כל המחרוזות של כתובות ה-URL של הסוגים חייבות להיות הפניות חוקיות ל-URI, עם הגבלה נוספת (לפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווי בריחה (escape) בקידוד אחוזים ותווים בקבוצה הבאה (לא כולל הגרשים ההפוכים החיצוניים): בעיצוב המקורי של |
value |
מכיל סריאליזציה של Protobuf מהסוג שמתואר על ידי type_url. מחרוזת בקידוד Base64. |
EvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| שדות | |
|---|---|
goldenEvaluationMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים. |
hallucinationMetricBehavior |
זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש ב- |
goldenHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות הזהב. |
scenarioHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות המדד "הזיות" בהערכות של תרחישים. |
GoldenEvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| שדות | |
|---|---|
turnLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור. |
expectationLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת הציפייה. |
toolMatchingSettings |
זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאת API מיותרת לכלי היא קריאה שקיימת בהרצה אבל לא תואמת לאף קריאת API לכלי בציפייה האידיאלית. |
ToolMatchingSettings
| ייצוג ב-JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| שדות | |
|---|---|
extraToolCallBehavior |
זה שינוי אופציונלי. התנהגות של קריאות API נוספות לכלי. ברירת המחדל היא FAIL. |
EvaluationConfig
| ייצוג ב-JSON |
|---|
{ "inputAudioConfig": { object ( |
| שדות | |
|---|---|
inputAudioConfig |
זה שינוי אופציונלי. הגדרות לעיבוד קלט האודיו. |
outputAudioConfig |
זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו. |
evaluationChannel |
זה שינוי אופציונלי. הערוץ שרוצים לבדוק. |
toolCallBehaviour |
זה שינוי אופציונלי. מציין אם ההערכה צריכה להשתמש בקריאות API אמיתיות לכלים או בכלים מזויפים. |
InputAudioConfig
| ייצוג ב-JSON |
|---|
{
"audioEncoding": enum ( |
| שדות | |
|---|---|
audioEncoding |
חובה. הקידוד של נתוני האודיו של הקלט. |
sampleRateHertz |
חובה. תדירות הדגימה (בהרץ) של נתוני האודיו של הקלט. |
noiseSuppressionLevel |
זה שינוי אופציונלי. אם להפעיל סינון רעשים בקלט האודיו. הערכים הזמינים הם "low", "moderate", "high", "very_high". |
OutputAudioConfig
| ייצוג ב-JSON |
|---|
{
"audioEncoding": enum ( |
| שדות | |
|---|---|
audioEncoding |
חובה. הקידוד של נתוני האודיו בפלט. |
sampleRateHertz |
חובה. תדירות הדגימה (בהרץ) של נתוני האודיו בפלט. |
EvaluationMetricsConfig
| ייצוג ב-JSON |
|---|
{ "goldenMetricsConfig": { object ( |
| שדות | |
|---|---|
goldenMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הזהב להערכה. |
scenarioMetricsConfig |
זה שינוי אופציונלי. הגדרת המדדים של התרחיש להערכה. |
GoldenMetricsConfig
| ייצוג ב-JSON |
|---|
{ "semanticSimilarityMetricsConfig": { object ( |
| שדות | |
|---|---|
semanticSimilarityMetricsConfig |
זה שינוי אופציונלי. הגדרה גלובלית למדדים של דמיון סמנטי. |
toolCorrectnessMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הדיוק של הכלי ברמת הפנייה. |
stepToolCorrectnessMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הדיוק של הכלי ברמת השלב. |
ToolCorrectnessMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableToolCorrectnessMetrics": boolean } |
| שדות | |
|---|---|
enableToolCorrectnessMetrics |
זה שינוי אופציונלי. אם לחשב מדדים של דיוק הכלים לצורך ההערכה. |
ScenarioMetricsConfig
| ייצוג ב-JSON |
|---|
{ "userGoalMetMetricsConfig": { object ( |
| שדות | |
|---|---|
userGoalMetMetricsConfig |
זה שינוי אופציונלי. הגדרת המדדים של עמידה ביעדי המשתמשים. |
expectationsMetMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדים ברמת הציפיות. |
UserGoalMetMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableUserGoalMetMetrics": boolean } |
| שדות | |
|---|---|
enableUserGoalMetMetrics |
זה שינוי אופציונלי. אם לחשב את המדדים של עמידה ביעדי המשתמשים לצורך ההערכה. |
ExpectationsMetMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableExpectationsMetMetrics": boolean } |
| שדות | |
|---|---|
enableExpectationsMetMetrics |
זה שינוי אופציונלי. אם לחשב את מדדי רמת הציפיות להערכה. |
FieldMask
| ייצוג ב-JSON |
|---|
{ "paths": [ string ] } |
| שדות | |
|---|---|
paths[] |
קבוצת הנתיבים של מסכת השדות. |
NullValue
מייצג null ב-JSON.
NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.
שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יבצעו סבב מלא לערך 0.
| טיפוסים בני מנייה (enum) | |
|---|---|
NULL_VALUE |
ערך Null. |
RecordingControl
האפליקציה יכולה להקליט ולתעד את ההחלטה שלה.
ה-enum הזה ניתן להרחבה, וייתכן שנוסיף לו ערכים חדשים בעתיד.
| טיפוסים בני מנייה (enum) | |
|---|---|
RECORDING_CONTROL_UNSPECIFIED |
האפליקציה לא שולטת בהקלטה. הגדרות הרישום ביומן של האפליקציה קובעות, כמו בכל סשן שבו השדה הזה לא מוגדר. |
RECORDING_ENABLED |
יכול להיות שהשיחה תוקלט ותתועד מעכשיו. |
RECORDING_DISABLED |
יכול להיות שהשיחה לא תוקלט או תתועד מכאן והלאה. |
ComparisonType
סוגי ההשוואות שנתמכים לבדיקת התשובה של הנציג.
| טיפוסים בני מנייה (enum) | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
סוג ההשוואה לא צוין. התנהגות ברירת המחדל היא SEMANTIC_SIMILARITY לתשובות של הסוכן ולקריאות API לכלי. |
EQUALS |
התאמה מדויקת של מחרוזת. |
CONTAINS |
התאמה למחרוזת משנה (בודקת אם המחרוזת הצפויה כלולה בתשובה בפועל). |
SEMANTIC_SIMILARITY |
התאמה לפי דמיון סמנטי (הערכת הדמיון במשמעות באמצעות מודל שפה גדול). |
SemanticSimilarityChannel
הערוץ שבו רוצים להשתמש לדמיון סמנטי.
| טיפוסים בני מנייה (enum) | |
|---|---|
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED |
לא צוין מדד. ברירת המחדל היא TEXT. |
TEXT |
שימוש בדמיון סמנטי של טקסט. |
AUDIO |
שימוש בדמיון סמנטי של אודיו. |
HallucinationMetricBehavior
ההתנהגות של מדד ההזיות. המדד תמיד יחושב, בלי קשר להתנהגות. ההבדל הוא שכשהמדד מושבת, הוא לא משמש לחישוב ציון ההערכה הכולל.
| טיפוסים בני מנייה (enum) | |
|---|---|
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת של מדד ההזיות. |
DISABLED |
השבתת המדד "הזיה". |
ENABLED |
הפעלת המדד "הזיות". |
TaskCompletionBehavior
ההתנהגות הצפויה של משימת המשתמש. המידע הזה משמש כדי לקבוע אם התרחיש הצליח.
| טיפוסים בני מנייה (enum) | |
|---|---|
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED |
ההתנהגות לא צוינה. ערך ברירת המחדל הוא TASK_SATISFIED. |
TASK_SATISFIED |
משימת המשתמש צריכה להסתיים בהצלחה. |
TASK_REJECTED |
צריך לדחות את המשימה של המשתמש. |
UserGoalBehavior
ההתנהגות הצפויה של יעד המשתמש. המידע הזה משמש כדי לקבוע אם התרחיש הצליח.
| טיפוסים בני מנייה (enum) | |
|---|---|
USER_GOAL_BEHAVIOR_UNSPECIFIED |
ההתנהגות לא צוינה. ערך ברירת המחדל הוא USER_GOAL_SATISFIED. |
USER_GOAL_SATISFIED |
המטרה של המשתמש צריכה להיות מושגת בהצלחה. |
USER_GOAL_REJECTED |
צריך לדחות את מטרת המשתמש. |
USER_GOAL_IGNORED |
להתעלם מהסטטוס של יעד המשתמש. |
ScenarioExecutionMode
מצב ההפעלה של הערכות התרחישים.
| טיפוסים בני מנייה (enum) | |
|---|---|
SCENARIO_EXECUTION_MODE_UNSPECIFIED |
מצב ההפעלה לא צוין. ברירת המחדל היא QUALITY_OPTIMIZED. |
QUALITY_OPTIMIZED |
מצב אופטימיזציה של איכות. |
SPEED_OPTIMIZED |
מצב אופטימיזציה למהירות. |
תוצאת הסריקה
התוצאה של ההערכה או הציפייה.
| טיפוסים בני מנייה (enum) | |
|---|---|
OUTCOME_UNSPECIFIED |
תוצאת ההערכה לא צוינה. |
PASS |
ההערכה/הציפייה עברה. במקרה של הערכה, המשמעות היא שכל הציפיות נענו. |
FAIL |
הערכה/ציפייה נכשלה. במקרה של הערכה, המשמעות היא שלפחות ציפייה אחת לא התממשה. |
SKIPPED |
ההערכה/הציפייה לא בוצעה. |
ErrorType
סוג השגיאה
| טיפוסים בני מנייה (enum) | |
|---|---|
ERROR_TYPE_UNSPECIFIED |
סוג שגיאה לא מזוהה. |
RUNTIME_FAILURE |
כשל במהלך ההרצה בזמן ריצה. |
CONVERSATION_RETRIEVAL_FAILURE |
לא הצלחנו לאחזר את השיחה מ-CES Runtime. |
METRIC_CALCULATION_FAILURE |
אי אפשר לחשב מדד או תוצאה. |
EVALUATION_UPDATE_FAILURE |
ההערכה לא עודכנה. |
QUOTA_EXHAUSTED |
המכסה נגמרה. |
USER_SIMULATION_FAILURE |
הסימולציה של המשתמש נכשלה. |
סוג
סוג ה-span. יכול להיות שבעתיד נוסיף עוד ערכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
TOOL |
טווח קריאת ה-API לכלי. |
USER_CALLBACK |
טווח הקריאה החוזרת של המשתמש. |
GUARDRAIL |
טווח של שכבת הגנה. |
LLM |
טווח LLM. |
MilestoneStatus
סטטוס אבן הדרך.
| טיפוסים בני מנייה (enum) | |
|---|---|
MILESTONE_STATUS_UNSPECIFIED |
סטטוס לא מוגדר. |
NOT_STARTED |
השלב עדיין לא התחיל. |
IN_PROGRESS |
האבן דרך מתבצעת כרגע. |
COMPLETED |
השלמתם את אבן הדרך. |
BackgroundEnvironment
סביבת אודיו מדומה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
לא צוינה סביבת רקע. |
CALL_CENTER |
סביבה של מוקד טלפוני. |
TRAFFIC |
סביבה עם רעשי תנועה. |
KIDS_NOISE |
סביבה עם רעש של ילדים. |
CAFE |
סביבה של בית קפה. |
ExecutionState
מצב הביצוע של תוצאת ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
מצב ההרצה של תוצאת ההערכה לא צוין. |
QUEUED |
הפעלת תוצאות ההערכה נמצאת בתור. |
RUNNING |
ההרצה של תוצאת ההערכה מתבצעת. |
COMPLETED |
ההרצה של תוצאת ההערכה הסתיימה. |
ERROR |
ההרצה של תוצאת ההערכה נכשלה בגלל שגיאה פנימית. |
CANCELLED |
ההרצה של תוצאת ההערכה בוטלה. |
ExtraToolCallBehavior
ההגדרה הזו קובעת מה קורה כשמתקבלת קריאת API נוספת לכלי. קריאת API מיותרת לכלי היא קריאה שקיימת בהרצה אבל לא תואמת לאף קריאת API לכלי בציפייה האידיאלית.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת. ברירת המחדל היא FAIL. |
FAIL |
ההערכה תיכשל אם תהיה קריאה נוספת לכלי. |
ALLOW |
מאשרים את קריאת ה-API הנוספת לכלי. |
AudioEncoding
AudioEncoding מציין את פורמט הקידוד של נתוני האודיו.
| טיפוסים בני מנייה (enum) | |
|---|---|
AUDIO_ENCODING_UNSPECIFIED |
קידוד אודיו לא מוגדר. |
LINEAR16 |
קידוד אודיו PCM ליניארי של 16 ביט. |
MULAW |
דגימות של 8 ביטים שדוחסות דגימות אודיו של 14 ביטים באמצעות G.711 PCMU/mu-law. |
ALAW |
דגימות של 8 ביטים שדוחסות דגימות אודיו של 14 ביטים באמצעות G.711 PCMU/A-law. |
EvaluationChannel
הערוץ שרוצים לבדוק.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_CHANNEL_UNSPECIFIED |
לא צוין ערוץ הערכה. |
TEXT |
ערוץ הערכה של טקסט בלבד. |
AUDIO |
ערוץ להערכת אודיו. |
EvaluationToolCallBehaviour
הגדרת ההתנהגות של קריאת API לכלי בהרצות של הערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED |
התנהגות לא מוגדרת של קריאת API לכלי. כברירת מחדל, המודל יבצע קריאות API לכלי אמיתיות. |
REAL |
משתמשים בקריאות אמיתיות לכלי. |
FAKE |
שימוש בקריאות API מזויפות לכלי. |
GoldenRunMethod
השיטה שבה משתמשים כדי להריץ את ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
GOLDEN_RUN_METHOD_UNSPECIFIED |
שיטת ההפעלה לא צוינה. |
STABLE |
מריצים את ההערכה כהפעלה מחדש יציבה, שבה כל שלב הוא סשן ייחודי, והשלבים הצפויים הקודמים מוזרקים כהקשר. |
NAIVE |
מריצים את ההערכה כהפעלה מחדש נאיבית, שבה ההרצה היא סשן יחיד בלי הזרקת הקשר. |
OutcomeMetadata
מטא-נתונים על תוצאות ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
OUTCOME_METADATA_UNSPECIFIED |
מטא-נתונים לא מוגדרים של תוצאות. |
GRACEFUL_HANDOFF |
ההערכה הובילה להעברה חלקה לנציג אנושי. |
סכימת הפלט
הערכה מייצגת את כל המידע שנדרש כדי לדמות ולהעריך נציג.
הערכה
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "description": string, "tags": [ string ], "evaluationDatasets": [ string ], "createTime": string, "createdBy": string, "updateTime": string, "lastUpdatedBy": string, "evaluationRuns": [ string ], "etag": string, "aggregatedMetrics": { object ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של ההערכה הזו. פורמט: |
displayName |
חובה. השם המוצג של ההערכה, שמוגדר על ידי המשתמש. ייחודי באפליקציה. |
description |
זה שינוי אופציונלי. תיאור של ההערכה שמוגדר על ידי המשתמש. |
tags[] |
זה שינוי אופציונלי. תגים שהמשתמשים מגדירים כדי לסווג את ההערכה. |
evaluationDatasets[] |
פלט בלבד. רשימת מערכי הנתונים להערכה שההערכה שייכת אליהם. פורמט: |
createTime |
פלט בלבד. חותמת הזמן של יצירת ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
createdBy |
פלט בלבד. המשתמש שיצר את ההערכה. |
updateTime |
פלט בלבד. חותמת זמן של מועד העדכון האחרון של ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
lastUpdatedBy |
פלט בלבד. המשתמש שעדכן לאחרונה את ההערכה. |
evaluationRuns[] |
פלט בלבד. ה-EvaluationRuns שההערכה הזו משויכת אליהם. |
etag |
פלט בלבד. Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים שבוצעו בו-זמנית. |
aggregatedMetrics |
פלט בלבד. המדדים המצטברים של ההערכה הזו בכל ההרצות. |
lastCompletedResult |
פלט בלבד. תוצאת ההערכה האחרונה של ההערכה הזו. |
invalid |
פלט בלבד. האם ההערכה לא תקינה. זה יכול לקרות אם הערכה מפנה לכלי, לערכת כלים או לסוכן שנמחקו מאז. |
lastTenResults[] |
פלט בלבד. 10 תוצאות ההערכה האחרונות של ההערכה הזו. השדה הזה מאוכלס רק אם include_last_ten_results מוגדר כ-true ב-ListEvaluationsRequest או ב-GetEvaluationRequest. |
evaluationMetricsThresholdOverride |
זה שינוי אופציונלי. ההגדרה הזו מבטלת את ערכי הסף של המדדים בהערכה הספציפית הזו. |
evaluationMetricsConfigOverride |
זה שינוי אופציונלי. ההגדרה הזו מבטלת את הגדרת המדדים להערכה הספציפית הזו. |
שדה של איחוד inputs. הקלט להערכה inputs יכול להיות רק אחד מהבאים: |
|
golden |
זה שינוי אופציונלי. השלבים העיקריים שצריך לבדוק. |
scenario |
זה שינוי אופציונלי. ההגדרות של התרחיש. |
זהוב
| ייצוג ב-JSON |
|---|
{
"turns": [
{
object ( |
| שדות | |
|---|---|
turns[] |
חובה. התורות המוזהבים שנדרשים כדי להפעיל מחדש שיחה מוזהבת. המספר המקסימלי של סבבים הוא 100. |
evaluationExpectations[] |
זה שינוי אופציונלי. הציפיות מההערכה שלפיהן תתבצע הערכה של השיחה שהופעלה מחדש. פורמט: |
GoldenTurn
| ייצוג ב-JSON |
|---|
{ "steps": [ { object ( |
| שדות | |
|---|---|
steps[] |
חובה. השלבים שצריך לבצע כדי להפעיל מחדש שיחה מוצלחת. |
rootSpan |
זה שינוי אופציונלי. היחידה הלוגית הבסיסית למעקב של תור הזהב לעיבוד ולתחזוקה של מידע קולי. ה-URI של האודיו חייב להכיל אודיו שנשמר בתדירות דגימה של 16Khz. |
turnLevelMetricsThresholdsOverride |
זה שינוי אופציונלי. שינוי ערכי הסף של המדדים ברמת הפנייה. |
hallucinationMetricBehaviorOverride |
זה שינוי אופציונלי. שינוי ברירת המחדל של התנהגות המדד "הזיות" ברמת התור. |
שלב
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד step. השלב שצריך לבצע. הערך step יכול להיות רק אחד מהבאים: |
|
userInput |
זה שינוי אופציונלי. קלט של משתמשים לשיחה. |
agentTransfer |
זה שינוי אופציונלי. להעביר את השיחה לנציג אחר. |
expectation |
זה שינוי אופציונלי. מבצעת ציפייה בתור הנוכחי. |
SessionInput
| ייצוג ב-JSON |
|---|
{ "willContinue": boolean, "recordingControl": enum ( |
| שדות | |
|---|---|
willContinue |
זה שינוי אופציונלי. דגל שמציין אם ההודעה הנוכחית היא חלק מקלט גדול יותר בסשן הסטרימינג הדו-כיווני. כשהערך הוא הערה: השדה הזה לא רלוונטי לקלט של אודיו ו-DTMF, כי הם תמיד מעובדים באופן אוטומטי על סמך האות של סיום הדיבור. |
recordingControl |
זה שינוי אופציונלי. אם השיחה עשויה להיות מוקלטת ומתועדת מכאן והלאה. השתמשו באפשרות הזו כשהאפליקציה, ולא הנציג, מחליטה מה אפשר לשמור: לדוגמה, כשמשתמש הקצה צריך להסכים להקלטה לפני שאפשר לשמור מידע כלשהו על השיחה. הערך נשאר בתוקף עד שהלקוח שולח ערך אחר, כך שצריך לשלוח אותו רק כשהתשובה משתנה. ההגדרות שפועלות כששלב בשיחה מסתיים קובעות מה יקרה בשלב הזה – אם האודיו שלו יגיע לקטגוריית ההקלטות ואם התמליל שלו יגיע להיסטוריית השיחות, ל-BigQuery ול-Cloud Logging. הוא כולל את הצד של הנציג וגם את הצד של משתמש הקצה. סבבים שמסתיימים לפני שהלקוח שולח את השדה הזה בפעם הראשונה מתועדים בהתאם להגדרות הרישום ביומן של האפליקציה, כאילו השדה לא קיים. אם יותר מקלט אחד באותה בקשה מגדיר את זה, הקלט האחרון הוא זה שקובע. |
שדה של איחוד input_type. סוג הקלט. הערך input_type יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט ממשתמש הקצה. |
dtmf |
זה שינוי אופציונלי. ספרות DTMF ממשתמש הקצה. |
audio |
זה שינוי אופציונלי. נתוני אודיו ממשתמש הקצה. מחרוזת בקידוד Base64. |
toolResponses |
זה שינוי אופציונלי. תוצאות ההפעלה של קריאות ה-API לכלי מהלקוח. |
image |
זה שינוי אופציונלי. נתוני תמונה ממשתמש הקצה. |
blob |
זה שינוי אופציונלי. נתוני Blob ממשתמש הקצה. |
variables |
זה שינוי אופציונלי. משתנים לפי הקשר של הסשן, עם מפתח לפי שם. סוכן ה-CES ישתמש רק במשתנים שהוגדרו באפליקציה. משתנים לא מזוהים עדיין יישלחו אל [Dialogflow agent][Agent.RemoteDialogflowAgent] כפרמטרים נוספים של סשן. |
event |
זה שינוי אופציונלי. קלט של אירוע. |
ToolResponses
| ייצוג ב-JSON |
|---|
{
"toolResponses": [
{
object ( |
| שדות | |
|---|---|
toolResponses[] |
זה שינוי אופציונלי. רשימת התוצאות של הרצת הכלי. |
ToolResponse
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט של אובייקט JSON. צריך להשתמש במפתח output כדי לציין את התגובה של הכלי, ובמפתח error כדי לציין את פרטי השגיאה (אם יש). אם המפתחות "output" ו-"error" לא צוינו, כל ה-"response" נחשב לתוצאת ההפעלה של הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שהכלי שהופעל טירגט; משקפת את |
שדה של איחוד tool_identifier. המזהה של הכלי שהופעל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי שהופעל מתוך ערכת הכלים. |
ToolsetTool
| ייצוג ב-JSON |
|---|
{ "toolset": string, "toolId": string } |
| שדות | |
|---|---|
toolset |
חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: |
toolId |
זה שינוי אופציונלי. מזהה הכלי שלפיו מסננים את הכלים כדי לאחזר את הסכימה שלהם. |
Struct
| ייצוג ב-JSON |
|---|
{ "fields": { string: value, ... } } |
| שדות | |
|---|---|
fields |
מפה לא מסודרת של ערכים שהוקלדו באופן דינמי. אובייקט שמכיל רשימה של צמדי |
FieldsEntry
| ייצוג ב-JSON |
|---|
{ "key": string, "value": value } |
| שדות | |
|---|---|
key |
|
value |
|
ערך
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד kind. סוג הערך. הערך kind יכול להיות רק אחד מהבאים: |
|
nullValue |
מייצג |
numberValue |
מייצג מספר ב-JSON. אסור להשתמש בערכים |
stringValue |
מייצג מחרוזת JSON. |
boolValue |
מייצג ערך בוליאני של JSON (ליטרל |
structValue |
מייצג אובייקט JSON. |
listValue |
מייצג מערך JSON. |
ListValue
| ייצוג ב-JSON |
|---|
{ "values": [ value ] } |
| שדות | |
|---|---|
values[] |
שדה חוזר של ערכים שהוקלדו באופן דינמי. |
תמונה
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string, "altText": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp |
data |
חובה. בייטים גולמיים של התמונה. מחרוזת בקידוד Base64. |
altText |
זה שינוי אופציונלי. הטקסט החלופי של התמונה. |
כתם
| ייצוג ב-JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME של נתוני המקור לפי תקן IANA. |
data |
חובה. בייטים גולמיים של ה-blob. מחרוזת בקידוד Base64. |
אירוע
| ייצוג ב-JSON |
|---|
{ "event": string, "variables": { object } } |
| שדות | |
|---|---|
event |
חובה. שם האירוע. |
variables |
זה שינוי אופציונלי. משתנים נוספים שמשויכים לאירוע. |
AgentTransfer
| ייצוג ב-JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| שדות | |
|---|---|
targetAgent |
חובה. הנציג שאליו מועברת השיחה. הנציג יטפל בשיחה מכאן והלאה. פורמט: |
displayName |
פלט בלבד. השם המוצג של הנציג. |
GoldenExpectation
| ייצוג ב-JSON |
|---|
{ "note": string, "skipEvaluation": boolean, "expectationLevelMetricsThresholdsOverride": { object ( |
| שדות | |
|---|---|
note |
זה שינוי אופציונלי. הערה לגבי הדרישה הזו, שימושית לדיווח כשבדיקות ספציפיות נכשלות. למשל, "Check_Payment_Tool_Called". |
skipEvaluation |
זה שינוי אופציונלי. אם המאפיין מוגדר בתור true, הציפייה הספציפית הזו לא תיבדק. |
expectationLevelMetricsThresholdsOverride |
זה שינוי אופציונלי. המדיניות הזו מבטלת את המדדים ברמת השלב. |
agentResponseSemanticSimilarityMetricsConfigOverride |
זה שינוי אופציונלי. שינויים במדדי הדמיון הסמנטי של agent_response. |
agentResponseHallucinationMetricsConfigOverride |
זה שינוי אופציונלי. שינויים במדדי ההזיה של agent_response. |
comparisonType |
זה שינוי אופציונלי. סוג ההשוואה שבה משתמשים לבדיקת הציפייה. |
שדה של איחוד condition. הבדיקה בפועל שצריך לבצע. הערך condition יכול להיות רק אחד מהבאים: |
|
toolCall |
זה שינוי אופציונלי. בודקים אם כלי ספציפי הופעל עם הפרמטרים. |
toolResponse |
זה שינוי אופציונלי. לבדוק אם כלי מסוים הגיב כמו שציפיתם. |
agentResponse |
זה שינוי אופציונלי. בודקים שהנציג השיב את התשובה הנכונה. התפקיד "סוכן" משתמע. |
agentTransfer |
זה שינוי אופציונלי. מוודאים שהנציג העביר את השיחה לנציג אחר. |
updatedVariables |
זה שינוי אופציונלי. בודקים שהנציג עדכן את משתני הסשן לערכים הצפויים. משמש גם כדי לתעד עדכונים של משתני סוכן להערכות זהב. |
mockToolResponse |
זה שינוי אופציונלי. תגובת הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
noToolCalls |
זה שינוי אופציונלי. מוודאים שלא הופעלו כלים במהלך התור הזה. |
ToolCall
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, "targetApp": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת ה-API לכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם ב- |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. הפרמטרים והערכים של הקלט לכלי בפורמט של אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת ה-API לכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאה ראשית. ריק לקריאות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת הקריאה שהתחילה אותה, במקום להציג כל שלב כרכיב אחים. |
agentName |
פלט בלבד. השם של הנציג שביצע את השיחה, בפורמט שקריא לבני אדם, למשל "אדריכל קבלן". השדה ריק כשהסוכן ברמה הבסיסית (root) הנפיק אותו. |
targetApp |
פלט בלבד. האפליקציה שאליה השיחה הזו מיועדת, נגזרת על ידי Assistant מהארגומנטים של המשאבים של השיחה: שם משאב של אפליקציה, |
שדה של איחוד tool_identifier. המזהה של הכלי שצריך להפעיל. הוא יכול להיות כלי קבוע או כלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי שרוצים להפעיל. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי להרצה מתוך ערכת הכלים. |
הודעה
| ייצוג ב-JSON |
|---|
{
"role": string,
"chunks": [
{
object ( |
| שדות | |
|---|---|
role |
זה שינוי אופציונלי. התפקיד בשיחה, למשל: משתמש, נציג. |
chunks[] |
זה שינוי אופציונלי. תוכן ההודעה כסדרה של קטעים. |
eventTime |
זה שינוי אופציונלי. חותמת הזמן של שליחת או קבלת ההודעה. אין להשתמש אם ההודעה היא חלק מ- הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
מקטע
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד data. נתוני המקטע. הערך data יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט. |
transcript |
זה שינוי אופציונלי. תמליל שמשויך לאודיו. |
blob |
זה שינוי אופציונלי. נתוני Blob. |
payload |
זה שינוי אופציונלי. נתוני מטען ייעודי (payload) בהתאמה אישית. |
image |
זה שינוי אופציונלי. נתוני התמונה. |
toolCall |
זה שינוי אופציונלי. בקשה להפעלת כלי. |
toolResponse |
זה שינוי אופציונלי. תגובה להרצת הכלי. |
agentTransfer |
זה שינוי אופציונלי. אירוע העברה של סוכן. |
updatedVariables |
מבנה שמייצג משתנים שעודכנו בשיחה, עם מפתחות לפי שמות המשתנים. |
defaultVariables |
מבנה שמייצג משתני ברירת מחדל בתחילת השיחה, עם מפתחות לפי שמות המשתנים. |
חותמת הזמן
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
מייצג שניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) 1970-01-01T00:00:00Z. הערך חייב להיות בין -62135596800 ל-253402300799, כולל (טווח שמתאים ל-0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z). |
nanos |
שברים לא שליליים של שנייה ברזולוציה של ננו-שנייה. השדה הזה הוא החלק של הננו-שניות במשך הזמן, ולא חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שנספרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל. |
ExpectationLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד הערך |
|
toolInvocationParameterCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה לתקינות של פרמטר קריאה לכלי ספציפי. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
SemanticSimilarityMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableSemanticSimilarityMetrics": boolean } |
| שדות | |
|---|---|
enableSemanticSimilarityMetrics |
זה שינוי אופציונלי. אם לחשב מדדי דמיון סמנטי להערכה. |
HallucinationMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableHallucinationMetrics": boolean } |
| שדות | |
|---|---|
enableHallucinationMetrics |
זה שינוי אופציונלי. אם לחשב מדדי הזיה להערכה. |
Span
| ייצוג ב-JSON |
|---|
{
"name": string,
"startTime": string,
"endTime": string,
"duration": string,
"attributes": {
object
},
"childSpans": [
{
object ( |
| שדות | |
|---|---|
name |
פלט בלבד. שם ה-span. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
duration |
פלט בלבד. משך הזמן של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
attributes |
פלט בלבד. מאפייני מפתח/ערך שמשויכים ל-span. |
childSpans[] |
פלט בלבד. ה-spans המשניים שמוטמעים ב-span הזה. |
משך
| ייצוג ב-JSON |
|---|
{ "seconds": string, "nanos": integer } |
| שדות | |
|---|---|
seconds |
שניות חתומות של משך הזמן. הערך חייב להיות בין -315,576,000,000 ל-+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים |
nanos |
שברים חתומים של שנייה ברזולוציה של ננו-שנייה של משך הזמן. משכי זמן של פחות משנייה מיוצגים על ידי שדה |
TurnLevelMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "semanticSimilarityChannel": enum ( |
| שדות | |
|---|---|
semanticSimilarityChannel |
זה שינוי אופציונלי. ערוץ הדמיון הסמנטי שבו משתמשים להערכה. |
שדה של איחוד הערך |
|
semanticSimilaritySuccessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדמיון הסמנטי. הערך חייב להיות מספר שלם בין 0 ל-4. ברירת המחדל היא >= 3. |
שדה של איחוד הערך |
|
overallToolInvocationCorrectnessThreshold |
זה שינוי אופציונלי. סף ההצלחה של הדיוק הכולל בהפעלת הכלים. הערך חייב להיות מספר עשרוני בין 0 ל-1. ברירת המחדל היא 1.0. |
תרחיש
| ייצוג ב-JSON |
|---|
{ "task": string, "userFacts": [ { object ( |
| שדות | |
|---|---|
task |
חובה. המשימה שהתרחיש מטרגט. |
userFacts[] |
זה שינוי אופציונלי. העובדות על המשתמשים שבהן התרחיש ישתמש. |
maxTurns |
זה שינוי אופציונלי. מספר התורות המקסימלי לסימולציה. הערך המקסימלי המותר הוא 100. ערך ברירת המחדל הוא 100. |
rubrics[] |
חובה. הקריטריונים להערכת התרחיש. |
scenarioExpectations[] |
חובה. ה-ScenarioExpectations להערכת השיחה שנוצרה על ידי סימולציית המשתמש. |
variableOverrides |
זה שינוי אופציונלי. משתנים או פרמטרים של סשן כהקשר לסשן, עם מפתחות לפי שמות המשתנים. האיברים של המבנה הזה יבטלו את ערכי ברירת המחדל שהוגדרו על ידי המערכת. חשוב לשים לב שהן שונות מעובדות של המשתמש, שהן עובדות שהמשתמש יודע. משתנים הם פרמטרים שהנציג מכיר: למשל, MDN (מספר טלפון) שמועבר על ידי מערכת הטלפוניה. |
taskCompletionBehavior |
זה שינוי אופציונלי. הוצאה משימוש, במקום זאת, צריך להשתמש ב-user_goal_behavior. |
userGoalBehavior |
זה שינוי אופציונלי. ההתנהגות הצפויה של יעד המשתמש. |
evaluationExpectations[] |
זה שינוי אופציונלי. הציפיות מההערכה שלפיהן תתבצע הערכת השיחה שנוצרה בסימולציה. פורמט: |
milestones[] |
זה שינוי אופציונלי. אבני הדרך בתרחיש הזה. |
scenarioExecutionMode |
זה שינוי אופציונלי. מצב ההפעלה של הערכות התרחישים. |
UserFact
| ייצוג ב-JSON |
|---|
{ "name": string, "value": string } |
| שדות | |
|---|---|
name |
חובה. השם של עובדת המשתמש. |
value |
חובה. הערך של העובדה על המשתמש. |
ScenarioExpectation
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה של איחוד expectation. הציפייה להערכת השיחה שנוצרה על ידי הסימולציה. הערך expectation יכול להיות רק אחד מהבאים: |
|
toolExpectation |
זה שינוי אופציונלי. צמד קריאת ה-API לכלי והתשובה שרוצים להעריך. |
agentResponse |
זה שינוי אופציונלי. תשובת הנציג שצריך להעריך. |
ToolExpectation
| ייצוג ב-JSON |
|---|
{ "expectedToolCall": { object ( |
| שדות | |
|---|---|
expectedToolCall |
חובה. קריאת ה-API לכלי שצפויה להתבצע, עם הפרמטרים הרלוונטיים. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
mockToolResponse |
חובה. תגובת הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל פרמטר שלא צוין ייווצר על ידי ה-LLM. |
אבן דרך
| ייצוג ב-JSON |
|---|
{
"goal": string,
"maxTurnCount": integer,
"successCriteria": string,
"protocol": string,
"staticUtterance": string,
"event": {
object ( |
| שדות | |
|---|---|
goal |
חובה. המטרה של אבן הדרך. |
maxTurnCount |
זה שינוי אופציונלי. מספר הפניות המקסימלי לאבן הדרך הזו. |
successCriteria |
זה שינוי אופציונלי. הקריטריונים להצלחה של אבן הדרך. |
protocol |
זה שינוי אופציונלי. ההנחיות שהנציג צריך לפעול לפיהן במהלך השיחה. |
staticUtterance |
זה שינוי אופציונלי. ביטוי סטטי שהסימולטור ישלח בדיוק כמו שהוא, במקום ליצור קלט משתמש באופן דינמי. |
event |
זה שינוי אופציונלי. קלט של אירוע שיישלח במקום יצירה דינמית. |
AggregatedMetrics
| ייצוג ב-JSON |
|---|
{
"metricsByAppVersion": [
{
object ( |
| שדות | |
|---|---|
metricsByAppVersion[] |
פלט בלבד. מדדים נצברים, מקובצים לפי מזהה גרסת האפליקציה. |
MetricsByAppVersion
| ייצוג ב-JSON |
|---|
{ "appVersionId": string, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
appVersionId |
פלט בלבד. מזהה גרסת האפליקציה. |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בגרסה הזו של האפליקציה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בגרסת האפליקציה הזו. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיות בגרסת האפליקציה הזו. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאות API לכלים בגרסה הזו של האפליקציה. |
turnLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של התור בגרסת האפליקציה הזו. |
passCount |
פלט בלבד. מספר הפעמים שהבדיקה עברה בהצלחה. |
failCount |
פלט בלבד. מספר הפעמים שההערכה נכשלה. |
metricsByTurn[] |
פלט בלבד. מדדים שנצברו לכל תור בגרסה הזו של האפליקציה. |
ToolMetrics
| ייצוג ב-JSON |
|---|
{ "tool": string, "passCount": integer, "failCount": integer } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי. |
passCount |
פלט בלבד. מספר הפעמים שהכלי עבר את הבדיקה. |
failCount |
פלט בלבד. מספר הפעמים שהכלי נכשל. |
SemanticSimilarityMetrics
| ייצוג ב-JSON |
|---|
{ "score": number } |
| שדות | |
|---|---|
score |
פלט בלבד. הציון הממוצע של הדמיון הסמנטי (0-4). |
HallucinationMetrics
| ייצוג ב-JSON |
|---|
{ "score": number } |
| שדות | |
|---|---|
score |
פלט בלבד. ציון ההזיה הממוצע (0 עד 1). |
ToolCallLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "tool": string, "averageLatency": string } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי. |
averageLatency |
פלט בלבד. זמן האחזור הממוצע של קריאות ה-API לכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
TurnLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "averageLatency": string } |
| שדות | |
|---|---|
averageLatency |
פלט בלבד. זמן האחזור הממוצע של התורות. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricsByTurn
| ייצוג ב-JSON |
|---|
{ "turnIndex": integer, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
turnIndex |
פלט בלבד. אינדקס התור (החל מ-0). |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בתור הזה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בתוך החלק הזה בשיחה. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיה בתור הזה. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאת ה-API לכלי במהלך הסבב הזה. |
turnLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של התור הזה. |
EvaluationResult
| ייצוג ב-JSON |
|---|
{ "name": string, "displayName": string, "createTime": string, "evaluationStatus": enum ( |
| שדות | |
|---|---|
name |
מזהה. המזהה הייחודי של תוצאת ההערכה. פורמט: |
displayName |
חובה. השם המוצג של תוצאת ההערכה. ייחודי בתוך הערכה. כברירת מחדל, הפורמט הוא: " |
createTime |
פלט בלבד. חותמת הזמן של יצירת תוצאת ההערכה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
evaluationStatus |
פלט בלבד. תוצאת הבדיקה. השדה הזה מאוכלס רק אם הערך של execution_state הוא COMPLETE. |
evaluationRun |
פלט בלבד. הרצת ההערכה שהפיקה את התוצאה הזו. פורמט: |
persona |
פלט בלבד. הפרסונה ששימשה ליצירת השיחה לתוצאת ההערכה. |
errorInfo |
פלט בלבד. פרטי השגיאה של תוצאת ההערכה. |
error |
פלט בלבד. הוצא משימוש: צריך להשתמש ב- |
initiatedBy |
פלט בלבד. המשתמש שהפעיל את הרצת ההערכה שהובילה לתוצאה הזו. |
appVersion |
פלט בלבד. גרסת האפליקציה שבה נוצרה השיחה שהובילה לתוצאה הזו. פורמט: |
appVersionDisplayName |
פלט בלבד. השם המוצג של ה- |
changelog |
פלט בלבד. יומן השינויים של גרסת האפליקציה שבה בוצעה ההערכה. השדה הזה מאוכלס אם המשתמש מריץ הערכה על הגרסה האחרונה או על טיוטה. |
changelogCreateTime |
פלט בלבד. זמן היצירה של יומן השינויים של גרסת האפליקציה שההערכה בוצעה לגביה. השדה הזה מאוכלס אם המשתמש מריץ הערכה על הגרסה האחרונה או על טיוטה. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionState |
פלט בלבד. מצב הביצוע של תוצאת ההערכה. |
evaluationMetricsThresholds |
פלט בלבד. סף ההערכה של התוצאה. |
config |
פלט בלבד. ההגדרות ששימשו להרצת ההערכה שהובילה לתוצאה הזו. |
goldenRunMethod |
פלט בלבד. השיטה שבה משתמשים כדי להריץ את הערכת הזהב. |
rootSpan |
פלט בלבד. היחידה הלוגית הבסיסית למעקב של הרצת ההערכה, שכוללת מידע על כל שלב בהערכה. |
outcomeMetadata |
פלט בלבד. המטא-נתונים של תוצאת ההערכה. השדה הזה מאוכלס רק אם הערך של execution_state הוא COMPLETE. |
שדה של איחוד result. תוצאת הבדיקה. השדה הזה מאוכלס רק כשערך השדה execution_state הוא COMPLETED. הערך result יכול להיות רק אחד מהבאים: |
|
goldenResult |
פלט בלבד. התוצאה של הערכת הזהב. |
scenarioResult |
פלט בלבד. התוצאה של הערכת התרחיש. |
GoldenResult
| ייצוג ב-JSON |
|---|
{ "turnReplayResults": [ { object ( |
| שדות | |
|---|---|
turnReplayResults[] |
פלט בלבד. התוצאה של הרצת כל שלב בשיחה האידיאלית. |
evaluationExpectationResults[] |
פלט בלבד. תוצאות הציפיות מההערכה. |
TurnReplayResult
| ייצוג ב-JSON |
|---|
{ "conversation": string, "expectationOutcome": [ { object ( |
| שדות | |
|---|---|
conversation |
פלט בלבד. השיחה שנוצרה בסבב הזה. |
expectationOutcome[] |
פלט בלבד. התוצאה של כל ציפייה. |
hallucinationResult |
פלט בלבד. תוצאת הבדיקה של ההזיות. |
toolInvocationScore |
פלט בלבד. הוצאה משימוש, במקום זאת, צריך להשתמש ב-OverallToolInvocationResult. |
turnLatency |
פלט בלבד. משך הזמן של הפנייה. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
toolCallLatencies[] |
פלט בלבד. זמן האחזור של כל קריאת API לכלי בסבב. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
overallToolInvocationResult |
פלט בלבד. התוצאה של הבדיקה הכוללת של הפעלת הכלי. |
errorInfo |
פלט בלבד. מידע על השגיאה שהתרחשה במהלך התור הזה. |
spanLatencies[] |
פלט בלבד. זמן האחזור של קטעי הטקסט בתור. |
שדה של איחוד הערך |
|
toolOrderedInvocationScore |
פלט בלבד. הציון הכולל של הפעלת הכלים לפי הסדר בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים מהתור הצפוי שהופעלו בפועל בסדר הצפוי. |
GoldenExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של הציפייה. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
toolInvocationResult |
פלט בלבד. התוצאה של בדיקת הפעלת הכלי. |
שדה של איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. התוצאה של הציפייה לקריאת API לכלי. |
observedToolResponse |
פלט בלבד. התוצאה של הציפייה לתגובה מהכלי. |
observedAgentResponse |
פלט בלבד. התוצאה של הציפייה לתגובה מהסוכן. |
observedAgentTransfer |
פלט בלבד. התוצאה של הציפייה להעברה לנציג. |
observedPayload |
פלט בלבד. מטען ייעודי (payload) מותאם אישית שנצפה. אין ציפיות לגבי מטען ייעודי (payload) מותאם אישית. הנתון הזה משמש רק לחישוב מדדים. התוצאה היא תמיד SKIPPED. |
SemanticSimilarityResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, "outcome": enum ( |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 4: עקביות מלאה, ציון 3: עקביות ברוב המקרים, ציון 2: עקביות חלקית (השמטות קלות), ציון 1: חוסר עקביות ברוב המקרים (השמטות משמעותיות), ציון 0: חוסר עקביות מוחלט או סתירה |
explanation |
פלט בלבד. ההסבר לציון הדמיון הסמנטי. |
outcome |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. ההחלטה מתקבלת על סמך השוואה בין הציון לבין semantic_similarity_success_threshold. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון הדמיון הסמנטי. הערך יכול להיות 0, 1, 2, 3 או 4. |
ToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. כדי לקבוע את זה, המערכת משווה את הערך של parameter_correctness_score לסף. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
explanation |
פלט בלבד. הסבר בטקסט חופשי על התוצאה של הפעלת הכלי. |
שדה של איחוד הערך |
|
parameterCorrectnessScore |
פלט בלבד. הציון של נכונות הפרמטרים להפעלת הכלי. המדד הזה מציין את אחוז הפרמטרים מקריאת ה-API הצפויה לכלי שהיו קיימים גם בקריאת ה-API בפועל לכלי. |
HallucinationResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 1: מוצדק, ציון 0: לא מוצדק, ציון 1-: אין טענה שצריך להעריך |
explanation |
פלט בלבד. ההסבר לציון ההזיה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון ההזיה. יכול להיות -1, 0, 1. |
ToolCallLatency
| ייצוג ב-JSON |
|---|
{ "tool": string, "displayName": string, "startTime": string, "endTime": string, "executionLatency": string } |
| שדות | |
|---|---|
tool |
פלט בלבד. שם הכלי שהופעל. פורמט: |
displayName |
פלט בלבד. השם המוצג של הכלי. |
startTime |
פלט בלבד. שעת ההתחלה של הרצת קריאת ה-API לכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הפעלת קריאת ה-API לכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionLatency |
פלט בלבד. זמן האחזור של הפעלת קריאת ה-API לכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
OverallToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. הציון נקבע על ידי השוואה בין tool_invocation_score לבין overall_tool_invocation_correctness_threshold. אם הציון שווה לסף או גבוה ממנו, התוצאה תהיה "עבר". אחרת, התוצאה תהיה FAIL. |
שדה של איחוד הערך |
|
toolInvocationScore |
הציון הכולל של הפעלת הכלים בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים שהופעלו בפועל מתוך הכלים שהיו צפויים לפעול בתור. |
EvaluationErrorInfo
| ייצוג ב-JSON |
|---|
{
"errorType": enum ( |
| שדות | |
|---|---|
errorType |
פלט בלבד. סוג השגיאה. |
errorMessage |
פלט בלבד. הודעת השגיאה. |
sessionId |
פלט בלבד. מזהה הסשן של השיחה שגרמה לשגיאה. |
userFacingErrorMessage |
פלט בלבד. הודעת השגיאה שמוצגת למשתמש. |
SpanLatency
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
פלט בלבד. סוג ה-span. |
displayName |
פלט בלבד. השם המוצג של ה-span. רלוונטי לטווחים של כלים ומעקות בטיחות. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
endTime |
פלט בלבד. שעת הסיום של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה מנורמל ל-Z וישתמש ב-0, 3, 6 או 9 ספרות אחרי הנקודה העשרונית. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. לדוגמה: |
executionLatency |
פלט בלבד. זמן האחזור של ה-span. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
שדה של איחוד identifier. המזהה של הפריט הספציפי, בהתאם לסוג שלו. הערך identifier יכול להיות רק אחד מהבאים: |
|
resource |
פלט בלבד. שם המשאב של טווחי ההנחיות או הכלים. |
toolset |
פלט בלבד. מזהה הכלי של ערכת הכלים. |
model |
פלט בלבד. שם ה-span של ה-LLM. |
callback |
פלט בלבד. השם של טווח הקריאה החוזרת (callback) של המשתמש. |
EvaluationExpectationResult
| ייצוג ב-JSON |
|---|
{
"evaluationExpectation": string,
"prompt": string,
"outcome": enum ( |
| שדות | |
|---|---|
evaluationExpectation |
פלט בלבד. הציפייה מההערכה. פורמט: |
prompt |
פלט בלבד. ההנחיה ששימשה להערכה. |
outcome |
פלט בלבד. התוצאה של ציפיית ההערכה. |
explanation |
פלט בלבד. ההסבר לתוצאה. |
ScenarioResult
| ייצוג ב-JSON |
|---|
{ "conversation": string, "task": string, "userFacts": [ { object ( |
| שדות | |
|---|---|
conversation |
פלט בלבד. השיחה שנוצרה בתרחיש. |
task |
פלט בלבד. המשימה ששימשה להפעלת התרחיש של התוצאה הזו. |
userFacts[] |
פלט בלבד. העובדות על המשתמש ששימשו את התרחיש לתוצאה הזו. |
expectationOutcomes[] |
פלט בלבד. התוצאה של כל ציפייה. |
rubricOutcomes[] |
פלט בלבד. התוצאה של הקריטריונים להערכה. |
hallucinationResult[] |
פלט בלבד. תוצאת הבדיקה של ההזיות. לכל שלב בשיחה תהיה תוצאת הזיה אחת. |
taskCompletionResult |
פלט בלבד. התוצאה של בדיקת השלמת המשימה. |
toolCallLatencies[] |
פלט בלבד. זמן האחזור של כל הפעלה של קריאת API לכלי בשיחה. |
userGoalSatisfactionResult |
פלט בלבד. התוצאה של בדיקת שביעות הרצון של המשתמש מהיעד. |
spanLatencies[] |
פלט בלבד. זמן האחזור של הטווחים בשיחה. |
evaluationExpectationResults[] |
פלט בלבד. תוצאות הציפיות מההערכה. |
milestoneResults[] |
פלט בלבד. התוצאות של כל ציון דרך בתרחיש. |
שדה של איחוד הערך |
|
allExpectationsSatisfied |
פלט בלבד. אם כל הציפיות נענו בתור הזה. |
שדה של איחוד הערך |
|
taskCompleted |
פלט בלבד. אם המשימה הושלמה בתור הזה. הציון הזה משקלל את כל הציפיות שנענו, את היעדר ההזיות ואת שביעות הרצון של המשתמש מהשגת המטרה. |
ScenarioExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של ScenarioExpectation. |
שדה של איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. קריאת ה-API לכלי שנצפתה. |
observedAgentResponse |
פלט בלבד. התשובה של הסוכן שנצפתה. |
ObservedToolCall
| ייצוג ב-JSON |
|---|
{ "toolCall": { object ( |
| שדות | |
|---|---|
toolCall |
פלט בלבד. קריאת ה-API לכלי שנצפתה. |
toolResponse |
פלט בלבד. התשובה שנצפתה מהכלי. |
ScenarioRubricOutcome
| ייצוג ב-JSON |
|---|
{ "rubric": string, "scoreExplanation": string, // Union field |
| שדות | |
|---|---|
rubric |
פלט בלבד. הקריטריונים ששימשו להערכת השיחה. |
scoreExplanation |
פלט בלבד. התשובה של הבודק לקריטריון ההערכה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. הציון של השיחה לפי קריטריון ההערכה. |
TaskCompletionResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 1: המשימה הושלמה, ציון 0: המשימה לא הושלמה, ציון 1-: יעד המשתמש לא מוגדר |
explanation |
פלט בלבד. ההסבר לציון השלמת המשימה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון השלמת המשימה. יכול להיות -1, 0, 1 |
UserGoalSatisfactionResult
| ייצוג ב-JSON |
|---|
{ "label": string, "explanation": string, // Union field |
| שדות | |
|---|---|
label |
פלט בלבד. התווית שמשויכת לכל ציון. ציון 2: העברה חלקה, ציון 1: המשימה של המשתמש בוצעה, ציון 0: המשימה של המשתמש לא בוצעה, ציון 1-: המשימה של המשתמש לא צוינה |
explanation |
פלט בלבד. ההסבר לציון שביעות הרצון של המשתמשים מהמשימה. |
שדה של איחוד הערך |
|
score |
פלט בלבד. ציון שביעות הרצון של המשתמש מהמשימה. יכול להיות -1, 0, 1, 2. |
MilestoneResult
| ייצוג ב-JSON |
|---|
{ "milestone": { object ( |
| שדות | |
|---|---|
milestone |
פלט בלבד. אבן הדרך שאחריה מתבצע מעקב. |
status |
פלט בלבד. הסטטוס הנוכחי של אבן הדרך. |
justification |
פלט בלבד. הסיבה לסטטוס הנוכחי. |
EvaluationPersona
| ייצוג ב-JSON |
|---|
{
"name": string,
"description": string,
"displayName": string,
"personality": string,
"speechConfig": {
object ( |
| שדות | |
|---|---|
name |
חובה. המזהה הייחודי של הפרסונה. פורמט: |
description |
זה שינוי אופציונלי. תיאור הפרסונה. |
displayName |
חובה. השם המוצג של הדמות. ייחודי באפליקציה. |
personality |
חובה. הוראה לסוכן לגבי אופן ההתנהגות בהערכה. |
speechConfig |
זה שינוי אופציונלי. הגדרות הקול של הפרסונה (הגדרות TTS). |
SpeechConfig
| ייצוג ב-JSON |
|---|
{
"speakingRate": number,
"environment": enum ( |
| שדות | |
|---|---|
speakingRate |
זה שינוי אופציונלי. קצב הדיבור. 1.0 הוא הערך הרגיל. ערך נמוך יותר הוא איטי יותר (למשל, 0.8), ערך גבוה יותר הוא מהיר יותר (למשל, 1.5). התכונה הזו שימושית כדי לבדוק איך הסוכן מתמודד עם אנשים שמדברים מהר. |
environment |
זה שינוי אופציונלי. סביבת האודיו המדומה. |
voiceId |
זה שינוי אופציונלי. המזהה הספציפי של הקול או המבטא שבו ייעשה שימוש. דוגמה: "en-US-Wavenet-D" או "en-GB-Standard-A" |
סטטוס
| ייצוג ב-JSON |
|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
| שדות | |
|---|---|
code |
קוד הסטטוס, שצריך להיות ערך enum של |
message |
הודעת שגיאה שמיועדת למפתחים, וצריכה להיות באנגלית. כל הודעת שגיאה שגלויה למשתמשים צריכה להיות מותאמת לשוק המקומי ולהישלח בשדה |
details[] |
רשימת הודעות עם פרטי השגיאה. יש קבוצה נפוצה של סוגי הודעות לשימוש בממשקי API. אובייקט שמכיל שדות מסוג שרירותי. שדה נוסף, |
הכול
| ייצוג ב-JSON |
|---|
{ "typeUrl": string, "value": string } |
| שדות | |
|---|---|
typeUrl |
מזהה את הסוג של הודעת Protobuf שעברה סריאליזציה באמצעות הפניה ל-URI שמורכבת מתחילית שמסתיימת בלוכסן ומשם הסוג המלא. דוגמה: type.googleapis.com/google.protobuf.StringValue המחרוזת הזו חייבת להכיל לפחות תו הקידומת היא שרירותית, וההטמעות של Protobuf אמורות פשוט להסיר את כל מה שמופיע עד ל- כל המחרוזות של כתובות ה-URL של הסוגים חייבות להיות הפניות חוקיות ל-URI, עם הגבלה נוספת (לפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווי בריחה (escape) בקידוד אחוזים ותווים בקבוצה הבאה (לא כולל הגרשים ההפוכים החיצוניים): בעיצוב המקורי של |
value |
מכיל סריאליזציה של Protobuf מהסוג שמתואר על ידי type_url. מחרוזת בקידוד Base64. |
EvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| שדות | |
|---|---|
goldenEvaluationMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים. |
hallucinationMetricBehavior |
זה שינוי אופציונלי. הוצא משימוש: צריך להשתמש ב- |
goldenHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות הזהב. |
scenarioHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות המדד "הזיות" בהערכות של תרחישים. |
GoldenEvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| שדות | |
|---|---|
turnLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור. |
expectationLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת הציפייה. |
toolMatchingSettings |
זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאת API מיותרת לכלי היא קריאה שקיימת בהרצה אבל לא תואמת לאף קריאת API לכלי בציפייה האידיאלית. |
ToolMatchingSettings
| ייצוג ב-JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| שדות | |
|---|---|
extraToolCallBehavior |
זה שינוי אופציונלי. התנהגות של קריאות API נוספות לכלי. ברירת המחדל היא FAIL. |
EvaluationConfig
| ייצוג ב-JSON |
|---|
{ "inputAudioConfig": { object ( |
| שדות | |
|---|---|
inputAudioConfig |
זה שינוי אופציונלי. הגדרות לעיבוד קלט האודיו. |
outputAudioConfig |
זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו. |
evaluationChannel |
זה שינוי אופציונלי. הערוץ שרוצים לבדוק. |
toolCallBehaviour |
זה שינוי אופציונלי. מציין אם ההערכה צריכה להשתמש בקריאות API אמיתיות לכלים או בכלים מזויפים. |
InputAudioConfig
| ייצוג ב-JSON |
|---|
{
"audioEncoding": enum ( |
| שדות | |
|---|---|
audioEncoding |
חובה. הקידוד של נתוני האודיו של הקלט. |
sampleRateHertz |
חובה. תדירות הדגימה (בהרץ) של נתוני האודיו של הקלט. |
noiseSuppressionLevel |
זה שינוי אופציונלי. אם להפעיל סינון רעשים בקלט האודיו. הערכים הזמינים הם "low", "moderate", "high", "very_high". |
OutputAudioConfig
| ייצוג ב-JSON |
|---|
{
"audioEncoding": enum ( |
| שדות | |
|---|---|
audioEncoding |
חובה. הקידוד של נתוני האודיו בפלט. |
sampleRateHertz |
חובה. תדירות הדגימה (בהרץ) של נתוני האודיו בפלט. |
EvaluationMetricsConfig
| ייצוג ב-JSON |
|---|
{ "goldenMetricsConfig": { object ( |
| שדות | |
|---|---|
goldenMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הזהב להערכה. |
scenarioMetricsConfig |
זה שינוי אופציונלי. הגדרת המדדים של התרחיש להערכה. |
GoldenMetricsConfig
| ייצוג ב-JSON |
|---|
{ "semanticSimilarityMetricsConfig": { object ( |
| שדות | |
|---|---|
semanticSimilarityMetricsConfig |
זה שינוי אופציונלי. הגדרה גלובלית למדדים של דמיון סמנטי. |
toolCorrectnessMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הדיוק של הכלי ברמת הפנייה. |
stepToolCorrectnessMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדי הדיוק של הכלי ברמת השלב. |
ToolCorrectnessMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableToolCorrectnessMetrics": boolean } |
| שדות | |
|---|---|
enableToolCorrectnessMetrics |
זה שינוי אופציונלי. אם לחשב מדדים של דיוק הכלים לצורך ההערכה. |
ScenarioMetricsConfig
| ייצוג ב-JSON |
|---|
{ "userGoalMetMetricsConfig": { object ( |
| שדות | |
|---|---|
userGoalMetMetricsConfig |
זה שינוי אופציונלי. הגדרת המדדים של עמידה ביעדי המשתמשים. |
expectationsMetMetricsConfig |
זה שינוי אופציונלי. הגדרת מדדים ברמת הציפיות. |
UserGoalMetMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableUserGoalMetMetrics": boolean } |
| שדות | |
|---|---|
enableUserGoalMetMetrics |
זה שינוי אופציונלי. אם לחשב את המדדים של עמידה ביעדי המשתמשים לצורך ההערכה. |
ExpectationsMetMetricsConfig
| ייצוג ב-JSON |
|---|
{ "enableExpectationsMetMetrics": boolean } |
| שדות | |
|---|---|
enableExpectationsMetMetrics |
זה שינוי אופציונלי. אם לחשב את מדדי רמת הציפיות להערכה. |
NullValue
מייצג null ב-JSON.
NullValue הוא sentinel, שמשתמש ב-enum עם ערך אחד בלבד כדי לייצג את הערך null לאיחוד מסוג Value.
שדה מסוג NullValue עם ערך שונה מ-0 נחשב לא תקין. רוב ה-serializers של ProtoJSON יפיקו Value עם null_value שמוגדר כ-null של JSON, בלי קשר לערך של המספר השלם, ולכן יבצעו סבב מלא לערך 0.
| טיפוסים בני מנייה (enum) | |
|---|---|
NULL_VALUE |
ערך Null. |
RecordingControl
האפליקציה יכולה להקליט ולתעד את ההחלטה שלה.
ה-enum הזה ניתן להרחבה, וייתכן שנוסיף לו ערכים חדשים בעתיד.
| טיפוסים בני מנייה (enum) | |
|---|---|
RECORDING_CONTROL_UNSPECIFIED |
האפליקציה לא שולטת בהקלטה. הגדרות הרישום ביומן של האפליקציה קובעות, כמו בכל סשן שבו השדה הזה לא מוגדר. |
RECORDING_ENABLED |
יכול להיות שהשיחה תוקלט ותתועד מעכשיו. |
RECORDING_DISABLED |
יכול להיות שהשיחה לא תוקלט או תתועד מכאן והלאה. |
ComparisonType
סוגי ההשוואות שנתמכים לבדיקת התשובה של הנציג.
| טיפוסים בני מנייה (enum) | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
סוג ההשוואה לא צוין. התנהגות ברירת המחדל היא SEMANTIC_SIMILARITY לתשובות של הסוכן ולקריאות API לכלי. |
EQUALS |
התאמה מדויקת של מחרוזת. |
CONTAINS |
התאמה למחרוזת משנה (בודקת אם המחרוזת הצפויה כלולה בתשובה בפועל). |
SEMANTIC_SIMILARITY |
התאמה לפי דמיון סמנטי (הערכת הדמיון במשמעות באמצעות מודל שפה גדול). |
SemanticSimilarityChannel
הערוץ שבו רוצים להשתמש לדמיון סמנטי.
| טיפוסים בני מנייה (enum) | |
|---|---|
SEMANTIC_SIMILARITY_CHANNEL_UNSPECIFIED |
לא צוין מדד. ברירת המחדל היא TEXT. |
TEXT |
שימוש בדמיון סמנטי של טקסט. |
AUDIO |
שימוש בדמיון סמנטי של אודיו. |
HallucinationMetricBehavior
ההתנהגות של מדד ההזיות. המדד תמיד יחושב, בלי קשר להתנהגות. ההבדל הוא שכשהמדד מושבת, הוא לא משמש לחישוב ציון ההערכה הכולל.
| טיפוסים בני מנייה (enum) | |
|---|---|
HALLUCINATION_METRIC_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת של מדד ההזיות. |
DISABLED |
השבתת המדד "הזיה". |
ENABLED |
הפעלת המדד "הזיות". |
TaskCompletionBehavior
ההתנהגות הצפויה של משימת המשתמש. המידע הזה משמש כדי לקבוע אם התרחיש הצליח.
| טיפוסים בני מנייה (enum) | |
|---|---|
TASK_COMPLETION_BEHAVIOR_UNSPECIFIED |
ההתנהגות לא צוינה. ערך ברירת המחדל הוא TASK_SATISFIED. |
TASK_SATISFIED |
משימת המשתמש צריכה להסתיים בהצלחה. |
TASK_REJECTED |
צריך לדחות את המשימה של המשתמש. |
UserGoalBehavior
ההתנהגות הצפויה של יעד המשתמש. המידע הזה משמש כדי לקבוע אם התרחיש הצליח.
| טיפוסים בני מנייה (enum) | |
|---|---|
USER_GOAL_BEHAVIOR_UNSPECIFIED |
ההתנהגות לא צוינה. ערך ברירת המחדל הוא USER_GOAL_SATISFIED. |
USER_GOAL_SATISFIED |
המטרה של המשתמש צריכה להיות מושגת בהצלחה. |
USER_GOAL_REJECTED |
צריך לדחות את מטרת המשתמש. |
USER_GOAL_IGNORED |
להתעלם מהסטטוס של יעד המשתמש. |
ScenarioExecutionMode
מצב ההפעלה של הערכות התרחישים.
| טיפוסים בני מנייה (enum) | |
|---|---|
SCENARIO_EXECUTION_MODE_UNSPECIFIED |
מצב ההפעלה לא צוין. ברירת המחדל היא QUALITY_OPTIMIZED. |
QUALITY_OPTIMIZED |
מצב אופטימיזציה של איכות. |
SPEED_OPTIMIZED |
מצב אופטימיזציה למהירות. |
תוצאת הסריקה
התוצאה של ההערכה או הציפייה.
| טיפוסים בני מנייה (enum) | |
|---|---|
OUTCOME_UNSPECIFIED |
תוצאת ההערכה לא צוינה. |
PASS |
ההערכה/הציפייה עברה. במקרה של הערכה, המשמעות היא שכל הציפיות נענו. |
FAIL |
הערכה/ציפייה נכשלה. במקרה של הערכה, המשמעות היא שלפחות ציפייה אחת לא התממשה. |
SKIPPED |
ההערכה/הציפייה לא בוצעה. |
ErrorType
סוג השגיאה
| טיפוסים בני מנייה (enum) | |
|---|---|
ERROR_TYPE_UNSPECIFIED |
סוג שגיאה לא מזוהה. |
RUNTIME_FAILURE |
כשל במהלך ההרצה בזמן ריצה. |
CONVERSATION_RETRIEVAL_FAILURE |
לא הצלחנו לאחזר את השיחה מ-CES Runtime. |
METRIC_CALCULATION_FAILURE |
אי אפשר לחשב מדד או תוצאה. |
EVALUATION_UPDATE_FAILURE |
ההערכה לא עודכנה. |
QUOTA_EXHAUSTED |
המכסה נגמרה. |
USER_SIMULATION_FAILURE |
הסימולציה של המשתמש נכשלה. |
סוג
סוג ה-span. יכול להיות שבעתיד נוסיף עוד ערכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
TOOL |
טווח קריאת ה-API לכלי. |
USER_CALLBACK |
טווח הקריאה החוזרת של המשתמש. |
GUARDRAIL |
טווח של שכבת הגנה. |
LLM |
טווח LLM. |
MilestoneStatus
סטטוס אבן הדרך.
| טיפוסים בני מנייה (enum) | |
|---|---|
MILESTONE_STATUS_UNSPECIFIED |
סטטוס לא מוגדר. |
NOT_STARTED |
השלב עדיין לא התחיל. |
IN_PROGRESS |
האבן דרך מתבצעת כרגע. |
COMPLETED |
השלמתם את אבן הדרך. |
BackgroundEnvironment
סביבת אודיו מדומה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
לא צוינה סביבת רקע. |
CALL_CENTER |
סביבה של מוקד טלפוני. |
TRAFFIC |
סביבה עם רעשי תנועה. |
KIDS_NOISE |
סביבה עם רעש של ילדים. |
CAFE |
סביבה של בית קפה. |
ExecutionState
מצב הביצוע של תוצאת ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
מצב ההרצה של תוצאת ההערכה לא צוין. |
QUEUED |
הפעלת תוצאות ההערכה נמצאת בתור. |
RUNNING |
ההרצה של תוצאת ההערכה מתבצעת. |
COMPLETED |
ההרצה של תוצאת ההערכה הסתיימה. |
ERROR |
ההרצה של תוצאת ההערכה נכשלה בגלל שגיאה פנימית. |
CANCELLED |
ההרצה של תוצאת ההערכה בוטלה. |
ExtraToolCallBehavior
ההגדרה הזו קובעת מה קורה כשמתקבלת קריאת API נוספת לכלי. קריאת API מיותרת לכלי היא קריאה שקיימת בהרצה אבל לא תואמת לאף קריאת API לכלי בציפייה האידיאלית.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת. ברירת המחדל היא FAIL. |
FAIL |
ההערכה תיכשל אם תהיה קריאה נוספת לכלי. |
ALLOW |
מאשרים את קריאת ה-API הנוספת לכלי. |
AudioEncoding
AudioEncoding מציין את פורמט הקידוד של נתוני האודיו.
| טיפוסים בני מנייה (enum) | |
|---|---|
AUDIO_ENCODING_UNSPECIFIED |
קידוד אודיו לא מוגדר. |
LINEAR16 |
קידוד אודיו PCM ליניארי של 16 ביט. |
MULAW |
דגימות של 8 ביטים שדוחסות דגימות אודיו של 14 ביטים באמצעות G.711 PCMU/mu-law. |
ALAW |
דגימות של 8 ביטים שדוחסות דגימות אודיו של 14 ביטים באמצעות G.711 PCMU/A-law. |
EvaluationChannel
הערוץ שרוצים לבדוק.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_CHANNEL_UNSPECIFIED |
לא צוין ערוץ הערכה. |
TEXT |
ערוץ הערכה של טקסט בלבד. |
AUDIO |
ערוץ להערכת אודיו. |
EvaluationToolCallBehaviour
הגדרת ההתנהגות של קריאת API לכלי בהרצות של הערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED |
התנהגות לא מוגדרת של קריאת API לכלי. כברירת מחדל, המודל יבצע קריאות API לכלי אמיתיות. |
REAL |
משתמשים בקריאות אמיתיות לכלי. |
FAKE |
שימוש בקריאות API מזויפות לכלי. |
GoldenRunMethod
השיטה שבה משתמשים כדי להריץ את ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
GOLDEN_RUN_METHOD_UNSPECIFIED |
שיטת ההפעלה לא צוינה. |
STABLE |
מריצים את ההערכה כהפעלה מחדש יציבה, שבה כל שלב הוא סשן ייחודי, והשלבים הצפויים הקודמים מוזרקים כהקשר. |
NAIVE |
מריצים את ההערכה כהפעלה מחדש נאיבית, שבה ההרצה היא סשן יחיד בלי הזרקת הקשר. |
OutcomeMetadata
מטא-נתונים על תוצאות ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
OUTCOME_METADATA_UNSPECIFIED |
מטא-נתונים לא מוגדרים של תוצאות. |
GRACEFUL_HANDOFF |
ההערכה הובילה להעברה חלקה לנציג אנושי. |
הערות לגבי הכלים
הערות לגבי כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי מסוים. רוב הלקוחות מתייחסים לרמזים האלה כלא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש בקשה לאישור.
בנוסף למחרוזת הכותרת, הרמזים הבוליאניים הבאים מוגדרים כך:
-
readOnlyHint: אם הערך הוא True, הכלי לא משנה את הסביבה שלו. ברירת המחדל: false. -
destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא False, הכלי יכול לבצע רק פעולות הוספה. ברירת המחדל: true. -
idempotentHint: אם הערך הוא True, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת המחדל: false. -
openWorldHint: אם הערך הוא True, הכלי יכול לקיים אינטראקציה עם "עולם פתוח" של ישויות חיצוניות. אם הערך הוא false, הכלי יכול לקיים אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי חיפוש באינטרנט הוא כלי בעולם פתוח, אבל כלי זיכרון הוא לא כלי בעולם פתוח.
Destructive Hint: ❌ | Idempotent Hint: ❌ | Read Only Hint: ❌ | Open World Hint: ❌