כלי: create_evaluation
יצירת הערכה חדשה.
בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי create_evaluation MCP.
| בקשת 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": "create_evaluation", "arguments": { // Provide these details according to the MCP tool specification. } }, "jsonrpc": "2.0", "id": 1 }' |
סכימת הקלט
בקשת הודעה עבור EvaluationService.CreateEvaluation.
CreateEvaluationRequest
| ייצוג ב-JSON |
|---|
{
"parent": string,
"evaluationId": string,
"evaluation": {
object ( |
| שדות | |
|---|---|
parent |
חובה. האפליקציה שעבורה רוצים ליצור את ההערכה. פורמט: |
evaluationId |
זה שינוי אופציונלי. המזהה שבו יש להשתמש להערכה, שיהפוך לרכיב הסופי של שם המשאב של ההערכה. אם לא מספקים מזהה, המערכת מקצה מזהה ייחודי באופן אוטומטי לצורך ההערכה. |
evaluation |
חובה. ההערכה שרוצים ליצור. |
הערכה
| ייצוג ב-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 |
זה שינוי אופציונלי. ההגדרה של תרחיש. |
Golden
| ייצוג ב-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, // Union field |
| שדות | |
|---|---|
willContinue |
זה שינוי אופציונלי. סימון שמציין אם ההודעה הנוכחית היא קטע מקלט גדול יותר בסשן של סטרימינג דו-כיווני. אם הערך הוא הערה: השדה הזה לא רלוונטי לקלט של אודיו ו-DTMF, כי הם תמיד מעובדים באופן אוטומטי על סמך אות סיום השיחה. |
שדה איחוד input_type. סוג הקלט. הערך input_type יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט ממשתמש הקצה. |
dtmf |
זה שינוי אופציונלי. ספרות DTMF ממשתמש הקצה. |
audio |
זה שינוי אופציונלי. נתוני אודיו ממשתמש הקצה. מחרוזת בקידוד Base64. |
toolResponses |
זה שינוי אופציונלי. תוצאות ההרצה של קריאות הכלים מהלקוח. |
image |
זה שינוי אופציונלי. נתוני תמונות ממשתמש הקצה. |
blob |
זה שינוי אופציונלי. נתוני Blob ממשתמש הקצה. |
variables |
זה שינוי אופציונלי. משתנים לפי הקשר של הסשן, עם שם כמפתח. הסוכן CES ישתמש רק במשתנים שהוגדרו באפליקציה. משתנים לא מזוהים עדיין יישלחו אל [סוכן Dialogflow][Agent.RemoteDialogflowAgent] כפרמטרים נוספים של הסשן. |
event |
זה שינוי אופציונלי. קלט האירוע. |
ToolResponses
| ייצוג ב-JSON |
|---|
{
"toolResponses": [
{
object ( |
| שדות | |
|---|---|
toolResponses[] |
זה שינוי אופציונלי. רשימת תוצאות ההרצה של הכלי. |
ToolResponse
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. מזהה התשובה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט אובייקט JSON. משתמשים במפתח 'output' כדי לציין את התגובה של הכלי ובמפתח 'error' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות output ו-error, כל התגובה נחשבת לתוצאת ההפעלה של הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו. |
שדה איחוד 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 |
מייצג JSON |
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 |
זה שינוי אופציונלי. הטקסט החלופי של התמונה. |
Blob
| ייצוג ב-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 |
זה שינוי אופציונלי. שינויים במדדים של הזיות בתשובות של סוכנים. |
comparisonType |
זה שינוי אופציונלי. סוג ההשוואה שמשמש לבדיקת הציפייה. |
שדה איחוד condition. הבדיקה בפועל שצריך לבצע. הערך condition יכול להיות רק אחד מהבאים: |
|
toolCall |
זה שינוי אופציונלי. בודקים אם בוצעה קריאה לכלי ספציפי עם הפרמטרים. |
toolResponse |
זה שינוי אופציונלי. בודקים אם הכלי הספציפי הגיב בצורה הצפויה. |
agentResponse |
זה שינוי אופציונלי. בודקים שהנציג הווירטואלי הגיב בתשובה הנכונה. התפקיד 'סוכן' מרומז. |
agentTransfer |
זה שינוי אופציונלי. בודקים שהנציג העביר את השיחה לנציג אחר. |
updatedVariables |
זה שינוי אופציונלי. בודקים שהסוכן עדכן את משתני הסשן לערכים הצפויים. המשתנה הזה משמש גם לתיעוד של עדכוני משתנים של סוכנים לצורך הערכות מוזהבות. |
mockToolResponse |
זה שינוי אופציונלי. התגובה של הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
noToolCalls |
זה שינוי אופציונלי. בודקים שלא נעשה שימוש בכלים במהלך התור הזה. |
ToolCall
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת הכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם בשדה |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. פרמטרי הקלט והערכים של הכלי בפורמט אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו. |
שדה איחוד 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 |
זה שינוי אופציונלי. נתונים של מטען ייעודי בהתאמה אישית. |
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 |
פלט בלבד. שם הטווח. |
startTime |
פלט בלבד. שעת ההתחלה של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
duration |
פלט בלבד. משך הזמן של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
attributes |
פלט בלבד. מאפייני מפתח/ערך שמשויכים לטווח. |
childSpans[] |
פלט בלבד. טווחים משניים שמוטמעים בטווח הזה. |
משך
| ייצוג ב-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[] |
זה שינוי אופציונלי. הציפיות להערכה שמשמשות להערכת השיחה שנוצרה על ידי הסימולציה. פורמט: |
scenarioExecutionMode |
זה שינוי אופציונלי. מצב ההפעלה של הערכות התרחישים. |
UserFact
| ייצוג ב-JSON |
|---|
{ "name": string, "value": string } |
| שדות | |
|---|---|
name |
חובה. השם של עובדת המשתמש. |
value |
חובה. הערך של נתון המשתמש. |
ScenarioExpectation
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד expectation. הציפייה להערכת השיחה שנוצרה על ידי הסימולציה. הערך expectation יכול להיות רק אחד מהבאים: |
|
toolExpectation |
זה שינוי אופציונלי. הזוג של קריאה לכלי ותגובה שצריך להעריך. |
agentResponse |
זה שינוי אופציונלי. התשובה של הסוכן שצריך להעריך. |
ToolExpectation
| ייצוג ב-JSON |
|---|
{ "expectedToolCall": { object ( |
| שדות | |
|---|---|
expectedToolCall |
חובה. הקריאה הצפויה לכלי, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
mockToolResponse |
חובה. התגובה של הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
AggregatedMetrics
| ייצוג ב-JSON |
|---|
{
"metricsByAppVersion": [
{
object ( |
| שדות | |
|---|---|
metricsByAppVersion[] |
פלט בלבד. מדדים מצטברים, שמקובצים לפי מזהה גרסת האפליקציה. |
MetricsByAppVersion
| ייצוג ב-JSON |
|---|
{ "appVersionId": string, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
appVersionId |
פלט בלבד. מזהה גרסת האפליקציה. |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בגרסה הזו של האפליקציה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בגרסת האפליקציה הזו. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיות בגרסת האפליקציה הזו. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאות לכלי בגרסת האפליקציה הזו. |
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 |
פלט בלבד. החביון הממוצע של הפעלות הכלים. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
TurnLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "averageLatency": string } |
| שדות | |
|---|---|
averageLatency |
פלט בלבד. זמן האחזור הממוצע של התורות. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricsByTurn
| ייצוג ב-JSON |
|---|
{ "turnIndex": integer, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
turnIndex |
פלט בלבד. אינדקס הפנייה (מתחיל מ-0). |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בתור הזה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים של דמיון סמנטי בתור הזה. |
hallucinationMetrics[] |
פלט בלבד. מדדים של הזיות בתור הזה. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאת הכלי בתור הזה. |
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[] |
פלט בלבד. זמן האחזור של כל קריאה לכלי בתור. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
overallToolInvocationResult |
פלט בלבד. התוצאה של הבדיקה הכוללת של הפעלת הכלי. |
errorInfo |
פלט בלבד. מידע על השגיאה שקרתה במהלך התור הזה. |
spanLatencies[] |
פלט בלבד. זמן האחזור של הטווחים בפנייה. |
שדה איחוד הערך |
|
toolOrderedInvocationScore |
פלט בלבד. הציון הכולל של הפעלת הכלי בתור הזה. המדד הזה מציין את אחוז הכלים הכולל מהתור הצפוי שהופעלו בפועל בסדר הצפוי. |
GoldenExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של הציפייה. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
toolInvocationResult |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. |
שדה איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. התוצאה של הציפייה לקריאה לכלי. |
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. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
שדה איחוד הערך |
|
score |
פלט בלבד. ציון הדמיון הסמנטי. יכול להיות 0, 1, 2, 3 או 4. |
ToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. ההחלטה מתקבלת על סמך השוואה בין הציון parameter_correctness_score לבין ערך הסף. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
explanation |
פלט בלבד. הסבר בטקסט חופשי על התוצאה של הפעלת הכלי. |
שדה איחוד הערך |
|
parameterCorrectnessScore |
פלט בלבד. ציון הנכונות של פרמטר ההפעלה של הכלי. הערך הזה מציין את אחוז הפרמטרים מהקריאה הצפויה לכלי שהיו גם בקריאה בפועל לכלי. |
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 |
פלט בלבד. שעת ההתחלה של ההרצה של קריאת הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של ההרצה של קריאת הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
executionLatency |
פלט בלבד. זמן האחזור של הפעלת הכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
OverallToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. הערך הזה נקבע על ידי השוואה בין tool_invocation_score לבין overall_tool_invocation_correctness_threshold. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
שדה איחוד הערך |
|
toolInvocationScore |
הציון הכולל של הפעלת הכלי בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים מהתור הצפוי שהופעלו בפועל. |
EvaluationErrorInfo
| ייצוג ב-JSON |
|---|
{
"errorType": enum ( |
| שדות | |
|---|---|
errorType |
פלט בלבד. סוג השגיאה. |
errorMessage |
פלט בלבד. הודעת השגיאה. |
sessionId |
פלט בלבד. מזהה הסשן של השיחה שגרמה לשגיאה. |
userFacingErrorMessage |
פלט בלבד. הודעת השגיאה שמוצגת למשתמש. |
SpanLatency
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
פלט בלבד. סוג הטווח. |
displayName |
פלט בלבד. השם המוצג של הטווח. ההגדרה הזו רלוונטית לטווחים של כלים ואמצעי הגנה. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
executionLatency |
פלט בלבד. זמן האחזור של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
שדה איחוד identifier. המזהה של הפריט הספציפי על סמך הסוג שלו. הערך identifier יכול להיות רק אחד מהבאים: |
|
resource |
פלט בלבד. שם המשאב של אמצעי הבקרה או של הכלים. |
toolset |
פלט בלבד. מזהה הכלי בערכת הכלים. |
model |
פלט בלבד. השם של טווח ה-LLM. |
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[] |
פלט בלבד. ההשהיה של כל הפעלה של קריאה לכלי בשיחה. |
userGoalSatisfactionResult |
פלט בלבד. התוצאה של בדיקת שביעות הרצון של המשתמש מהיעד. |
spanLatencies[] |
פלט בלבד. ההשהיה של טווחי הזמן בשיחה. |
evaluationExpectationResults[] |
פלט בלבד. התוצאות של ציפיות ההערכה. |
שדה איחוד הערך |
|
allExpectationsSatisfied |
פלט בלבד. אם כל הציפיות התממשו בתור הזה. |
שדה איחוד הערך |
|
taskCompleted |
פלט בלבד. האם המשימה הושלמה בתור הזה. התשובה הזו היא שילוב של כל הציפיות שהתממשו, ללא הזיות, ושל שביעות רצון המשתמש מהשגת היעד. |
ScenarioExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של ScenarioExpectation. |
שדה איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. הקריאה לכלי שנצפתה. |
observedAgentResponse |
פלט בלבד. התשובה שנצפתה מהסוכן. |
ObservedToolCall
| ייצוג ב-JSON |
|---|
{ "toolCall": { object ( |
| שדות | |
|---|---|
toolCall |
פלט בלבד. הקריאה לכלי שנצפתה. |
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. |
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 חוקיות, עם הגבלה נוספת (בפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווים מוברחים בקידוד אחוזים ותווים בערכה הבאה (לא כולל הגרשיים החיצוניים): בתכנון המקורי של |
value |
מכיל סריאליזציה של Protobuf של הסוג שמתואר על ידי type_url. מחרוזת בקידוד Base64. |
EvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| שדות | |
|---|---|
goldenEvaluationMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים. |
hallucinationMetricBehavior |
זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב- |
goldenHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות מוזהבות. |
scenarioHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות של תרחישים. |
GoldenEvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| שדות | |
|---|---|
turnLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור. |
expectationLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי רמת הציפייה. |
toolMatchingSettings |
זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת. |
ToolMatchingSettings
| ייצוג ב-JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| שדות | |
|---|---|
extraToolCallBehavior |
זה שינוי אופציונלי. התנהגות של קריאות נוספות לכלים. ברירת המחדל היא FAIL. |
EvaluationConfig
| ייצוג ב-JSON |
|---|
{ "inputAudioConfig": { object ( |
| שדות | |
|---|---|
inputAudioConfig |
זה שינוי אופציונלי. הגדרות לעיבוד האודיו שמתקבל. |
outputAudioConfig |
זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו. |
evaluationChannel |
זה שינוי אופציונלי. הערוץ שרוצים לבדוק. |
toolCallBehaviour |
זה שינוי אופציונלי. מציין אם ההערכה צריכה להשתמש בקריאות אמיתיות לכלים או בכלים מזויפים. |
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
מייצג JSON null.
NullValue הוא ערך שמירה, שמשתמש בסוג enum עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.
שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב הסריאליזטורים של ProtoJSON יפלטו Value עם null_value שמוגדר כ-JSON null בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 0.
| טיפוסים בני מנייה (enum) | |
|---|---|
NULL_VALUE |
ערך null. |
ComparisonType
סוגי השוואות נתמכים לבדיקת התשובה של הסוכן.
| טיפוסים בני מנייה (enum) | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
סוג ההשוואה לא צוין. ההתנהגות מוגדרת כברירת מחדל ל-SEMANTIC_SIMILARITY לתגובות של סוכנים ולקריאות כלים. |
EQUALS |
התאמה מדויקת של מחרוזת. |
CONTAINS |
התאמה של מחרוזת משנה (בדיקה אם המחרוזת הצפויה כלולה בתשובה בפועל). |
SEMANTIC_SIMILARITY |
התאמה של דמיון סמנטי (הערכת דמיון המשמעות באמצעות LLM). |
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 |
כשל במהלך סימולציית משתמש. |
סוג
סוג הטווח. יכול להיות שבעתיד נוסיף עוד ערכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
TOOL |
טווח של קריאה לכלי. |
USER_CALLBACK |
טווח הזמן של בקשת השיחה מהמשתמש. |
GUARDRAIL |
טווח שכבת ההגנה. |
LLM |
טווח LLM. |
BackgroundEnvironment
סביבת אודיו מדומה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
לא צוינה סביבת רקע. |
CALL_CENTER |
סביבת מוקד טלפוני. |
TRAFFIC |
סביבה עם רעשי תנועה. |
KIDS_NOISE |
סביבה רועשת של ילדים. |
CAFE |
סביבת בית קפה. |
ExecutionState
הסטטוס של הביצוע של תוצאת ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
לא צוין מצב הביצוע של תוצאת ההערכה. |
QUEUED |
ההפעלה של תוצאת ההערכה ממתינה בתור. |
RUNNING |
ההרצה של תוצאת ההערכה מתבצעת. |
COMPLETED |
ההרצה של תוצאת ההערכה הסתיימה. |
ERROR |
הביצוע של תוצאת ההערכה נכשל בגלל שגיאה פנימית. |
CANCELLED |
ההרצה של תוצאת ההערכה בוטלה. |
ExtraToolCallBehavior
הגדרת ההתנהגות כשנתקלים בקריאה נוספת לכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת. ברירת המחדל היא FAIL. |
FAIL |
הבדיקה תיכשל אם תזוהה קריאה נוספת לכלי. |
ALLOW |
מאשרים את השימוש בכלי הנוסף. |
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
הגדרת אופן הפעולה של קריאות לכלי בהרצות של הערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED |
התנהגות לא מוגדרת של קריאה לכלי. ברירת המחדל תהיה הפעלת כלים אמיתיים. |
REAL |
להשתמש בקריאות אמיתיות לכלים. |
FAKE |
שימוש בקריאות מזויפות לכלים. |
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 |
זה שינוי אופציונלי. ההגדרה של תרחיש. |
Golden
| ייצוג ב-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, // Union field |
| שדות | |
|---|---|
willContinue |
זה שינוי אופציונלי. סימון שמציין אם ההודעה הנוכחית היא קטע מקלט גדול יותר בסשן של סטרימינג דו-כיווני. אם הערך הוא הערה: השדה הזה לא רלוונטי לקלט של אודיו ו-DTMF, כי הם תמיד מעובדים באופן אוטומטי על סמך אות סיום השיחה. |
שדה איחוד input_type. סוג הקלט. הערך input_type יכול להיות רק אחד מהבאים: |
|
text |
זה שינוי אופציונלי. נתוני טקסט ממשתמש הקצה. |
dtmf |
זה שינוי אופציונלי. ספרות DTMF ממשתמש הקצה. |
audio |
זה שינוי אופציונלי. נתוני אודיו ממשתמש הקצה. מחרוזת בקידוד Base64. |
toolResponses |
זה שינוי אופציונלי. תוצאות ההרצה של קריאות הכלים מהלקוח. |
image |
זה שינוי אופציונלי. נתוני תמונות ממשתמש הקצה. |
blob |
זה שינוי אופציונלי. נתוני Blob ממשתמש הקצה. |
variables |
זה שינוי אופציונלי. משתנים לפי הקשר של הסשן, עם שם כמפתח. הסוכן CES ישתמש רק במשתנים שהוגדרו באפליקציה. משתנים לא מזוהים עדיין יישלחו אל [סוכן Dialogflow][Agent.RemoteDialogflowAgent] כפרמטרים נוספים של הסשן. |
event |
זה שינוי אופציונלי. קלט האירוע. |
ToolResponses
| ייצוג ב-JSON |
|---|
{
"toolResponses": [
{
object ( |
| שדות | |
|---|---|
toolResponses[] |
זה שינוי אופציונלי. רשימת תוצאות ההרצה של הכלי. |
ToolResponse
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. מזהה התשובה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט אובייקט JSON. משתמשים במפתח 'output' כדי לציין את התגובה של הכלי ובמפתח 'error' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות output ו-error, כל התגובה נחשבת לתוצאת ההפעלה של הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו. |
שדה איחוד 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 |
מייצג JSON |
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 |
זה שינוי אופציונלי. הטקסט החלופי של התמונה. |
Blob
| ייצוג ב-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 |
זה שינוי אופציונלי. שינויים במדדים של הזיות בתשובות של סוכנים. |
comparisonType |
זה שינוי אופציונלי. סוג ההשוואה שמשמש לבדיקת הציפייה. |
שדה איחוד condition. הבדיקה בפועל שצריך לבצע. הערך condition יכול להיות רק אחד מהבאים: |
|
toolCall |
זה שינוי אופציונלי. בודקים אם בוצעה קריאה לכלי ספציפי עם הפרמטרים. |
toolResponse |
זה שינוי אופציונלי. בודקים אם הכלי הספציפי הגיב בצורה הצפויה. |
agentResponse |
זה שינוי אופציונלי. בודקים שהנציג הווירטואלי הגיב בתשובה הנכונה. התפקיד 'סוכן' מרומז. |
agentTransfer |
זה שינוי אופציונלי. בודקים שהנציג העביר את השיחה לנציג אחר. |
updatedVariables |
זה שינוי אופציונלי. בודקים שהסוכן עדכן את משתני הסשן לערכים הצפויים. המשתנה הזה משמש גם לתיעוד של עדכוני משתנים של סוכנים לצורך הערכות מוזהבות. |
mockToolResponse |
זה שינוי אופציונלי. התגובה של הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
noToolCalls |
זה שינוי אופציונלי. בודקים שלא נעשה שימוש בכלים במהלך התור הזה. |
ToolCall
| ייצוג ב-JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת הכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם בשדה |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. פרמטרי הקלט והערכים של הכלי בפורמט אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, אם היא הופקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. ריק אם הסוכן הראשי הנפיק אותו. |
שדה איחוד 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 |
זה שינוי אופציונלי. נתונים של מטען ייעודי בהתאמה אישית. |
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 |
פלט בלבד. שם הטווח. |
startTime |
פלט בלבד. שעת ההתחלה של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
duration |
פלט בלבד. משך הזמן של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
attributes |
פלט בלבד. מאפייני מפתח/ערך שמשויכים לטווח. |
childSpans[] |
פלט בלבד. טווחים משניים שמוטמעים בטווח הזה. |
משך
| ייצוג ב-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[] |
זה שינוי אופציונלי. הציפיות להערכה שמשמשות להערכת השיחה שנוצרה על ידי הסימולציה. פורמט: |
scenarioExecutionMode |
זה שינוי אופציונלי. מצב ההפעלה של הערכות התרחישים. |
UserFact
| ייצוג ב-JSON |
|---|
{ "name": string, "value": string } |
| שדות | |
|---|---|
name |
חובה. השם של עובדת המשתמש. |
value |
חובה. הערך של נתון המשתמש. |
ScenarioExpectation
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד expectation. הציפייה להערכת השיחה שנוצרה על ידי הסימולציה. הערך expectation יכול להיות רק אחד מהבאים: |
|
toolExpectation |
זה שינוי אופציונלי. הזוג של קריאה לכלי ותגובה שצריך להעריך. |
agentResponse |
זה שינוי אופציונלי. התשובה של הסוכן שצריך להעריך. |
ToolExpectation
| ייצוג ב-JSON |
|---|
{ "expectedToolCall": { object ( |
| שדות | |
|---|---|
expectedToolCall |
חובה. הקריאה הצפויה לכלי, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
mockToolResponse |
חובה. התגובה של הכלי ל-mock, עם הפרמטרים הרלוונטיים שצוינו. כל הפרמטרים שלא צוינו יומצאו על ידי מודל ה-LLM. |
AggregatedMetrics
| ייצוג ב-JSON |
|---|
{
"metricsByAppVersion": [
{
object ( |
| שדות | |
|---|---|
metricsByAppVersion[] |
פלט בלבד. מדדים מצטברים, שמקובצים לפי מזהה גרסת האפליקציה. |
MetricsByAppVersion
| ייצוג ב-JSON |
|---|
{ "appVersionId": string, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
appVersionId |
פלט בלבד. מזהה גרסת האפליקציה. |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בגרסה הזו של האפליקציה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים לדמיון סמנטי בגרסת האפליקציה הזו. |
hallucinationMetrics[] |
פלט בלבד. מדדים להזיות בגרסת האפליקציה הזו. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאות לכלי בגרסת האפליקציה הזו. |
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 |
פלט בלבד. החביון הממוצע של הפעלות הכלים. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
TurnLatencyMetrics
| ייצוג ב-JSON |
|---|
{ "averageLatency": string } |
| שדות | |
|---|---|
averageLatency |
פלט בלבד. זמן האחזור הממוצע של התורות. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
MetricsByTurn
| ייצוג ב-JSON |
|---|
{ "turnIndex": integer, "toolMetrics": [ { object ( |
| שדות | |
|---|---|
turnIndex |
פלט בלבד. אינדקס הפנייה (מתחיל מ-0). |
toolMetrics[] |
פלט בלבד. מדדים לכל כלי בתור הזה. |
semanticSimilarityMetrics[] |
פלט בלבד. מדדים של דמיון סמנטי בתור הזה. |
hallucinationMetrics[] |
פלט בלבד. מדדים של הזיות בתור הזה. |
toolCallLatencyMetrics[] |
פלט בלבד. מדדים של זמן האחזור של קריאת הכלי בתור הזה. |
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[] |
פלט בלבד. זמן האחזור של כל קריאה לכלי בתור. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
overallToolInvocationResult |
פלט בלבד. התוצאה של הבדיקה הכוללת של הפעלת הכלי. |
errorInfo |
פלט בלבד. מידע על השגיאה שקרתה במהלך התור הזה. |
spanLatencies[] |
פלט בלבד. זמן האחזור של הטווחים בפנייה. |
שדה איחוד הערך |
|
toolOrderedInvocationScore |
פלט בלבד. הציון הכולל של הפעלת הכלי בתור הזה. המדד הזה מציין את אחוז הכלים הכולל מהתור הצפוי שהופעלו בפועל בסדר הצפוי. |
GoldenExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של הציפייה. |
semanticSimilarityResult |
פלט בלבד. התוצאה של בדיקת הדמיון הסמנטי. |
toolInvocationResult |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. |
שדה איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. התוצאה של הציפייה לקריאה לכלי. |
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. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
שדה איחוד הערך |
|
score |
פלט בלבד. ציון הדמיון הסמנטי. יכול להיות 0, 1, 2, 3 או 4. |
ToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. ההחלטה מתקבלת על סמך השוואה בין הציון parameter_correctness_score לבין ערך הסף. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
explanation |
פלט בלבד. הסבר בטקסט חופשי על התוצאה של הפעלת הכלי. |
שדה איחוד הערך |
|
parameterCorrectnessScore |
פלט בלבד. ציון הנכונות של פרמטר ההפעלה של הכלי. הערך הזה מציין את אחוז הפרמטרים מהקריאה הצפויה לכלי שהיו גם בקריאה בפועל לכלי. |
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 |
פלט בלבד. שעת ההתחלה של ההרצה של קריאת הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של ההרצה של קריאת הכלי. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
executionLatency |
פלט בלבד. זמן האחזור של הפעלת הכלי. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
OverallToolInvocationResult
| ייצוג ב-JSON |
|---|
{ "outcome": enum ( |
| שדות | |
|---|---|
outcome |
פלט בלבד. התוצאה של בדיקת ההפעלה של הכלי. הערך הזה נקבע על ידי השוואה בין tool_invocation_score לבין overall_tool_invocation_correctness_threshold. אם הניקוד שווה לסף או גבוה ממנו, התוצאה תהיה PASS. אחרת, התוצאה תהיה FAIL. |
שדה איחוד הערך |
|
toolInvocationScore |
הציון הכולל של הפעלת הכלי בתור הזה. המדד הזה מציין את האחוז הכולל של הכלים מהתור הצפוי שהופעלו בפועל. |
EvaluationErrorInfo
| ייצוג ב-JSON |
|---|
{
"errorType": enum ( |
| שדות | |
|---|---|
errorType |
פלט בלבד. סוג השגיאה. |
errorMessage |
פלט בלבד. הודעת השגיאה. |
sessionId |
פלט בלבד. מזהה הסשן של השיחה שגרמה לשגיאה. |
userFacingErrorMessage |
פלט בלבד. הודעת השגיאה שמוצגת למשתמש. |
SpanLatency
| ייצוג ב-JSON |
|---|
{ "type": enum ( |
| שדות | |
|---|---|
type |
פלט בלבד. סוג הטווח. |
displayName |
פלט בלבד. השם המוצג של הטווח. ההגדרה הזו רלוונטית לטווחים של כלים ואמצעי הגנה. |
startTime |
פלט בלבד. שעת ההתחלה של הטווח. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
endTime |
פלט בלבד. שעת הסיום של טווח הזמן. הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: |
executionLatency |
פלט בלבד. זמן האחזור של הטווח. משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב- |
שדה איחוד identifier. המזהה של הפריט הספציפי על סמך הסוג שלו. הערך identifier יכול להיות רק אחד מהבאים: |
|
resource |
פלט בלבד. שם המשאב של אמצעי הבקרה או של הכלים. |
toolset |
פלט בלבד. מזהה הכלי בערכת הכלים. |
model |
פלט בלבד. השם של טווח ה-LLM. |
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[] |
פלט בלבד. ההשהיה של כל הפעלה של קריאה לכלי בשיחה. |
userGoalSatisfactionResult |
פלט בלבד. התוצאה של בדיקת שביעות הרצון של המשתמש מהיעד. |
spanLatencies[] |
פלט בלבד. ההשהיה של טווחי הזמן בשיחה. |
evaluationExpectationResults[] |
פלט בלבד. התוצאות של ציפיות ההערכה. |
שדה איחוד הערך |
|
allExpectationsSatisfied |
פלט בלבד. אם כל הציפיות התממשו בתור הזה. |
שדה איחוד הערך |
|
taskCompleted |
פלט בלבד. האם המשימה הושלמה בתור הזה. התשובה הזו היא שילוב של כל הציפיות שהתממשו, ללא הזיות, ושל שביעות רצון המשתמש מהשגת היעד. |
ScenarioExpectationOutcome
| ייצוג ב-JSON |
|---|
{ "expectation": { object ( |
| שדות | |
|---|---|
expectation |
פלט בלבד. הציפייה שנבדקה. |
outcome |
פלט בלבד. התוצאה של ScenarioExpectation. |
שדה איחוד result. התוצאה של הציפייה. הערך result יכול להיות רק אחד מהבאים: |
|
observedToolCall |
פלט בלבד. הקריאה לכלי שנצפתה. |
observedAgentResponse |
פלט בלבד. התשובה שנצפתה מהסוכן. |
ObservedToolCall
| ייצוג ב-JSON |
|---|
{ "toolCall": { object ( |
| שדות | |
|---|---|
toolCall |
פלט בלבד. הקריאה לכלי שנצפתה. |
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. |
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 חוקיות, עם הגבלה נוספת (בפורמט הטקסט) שלפיה התוכן של ההפניה חייב לכלול רק תווים אלפאנומריים, תווים מוברחים בקידוד אחוזים ותווים בערכה הבאה (לא כולל הגרשיים החיצוניים): בתכנון המקורי של |
value |
מכיל סריאליזציה של Protobuf של הסוג שמתואר על ידי type_url. מחרוזת בקידוד Base64. |
EvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "goldenEvaluationMetricsThresholds": { object ( |
| שדות | |
|---|---|
goldenEvaluationMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי ההערכה המושלמים. |
hallucinationMetricBehavior |
זה שינוי אופציונלי. הוצא משימוש: במקומו צריך להשתמש ב- |
goldenHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות מוזהבות. |
scenarioHallucinationMetricBehavior |
זה שינוי אופציונלי. התנהגות מדד ההזיות בהערכות של תרחישים. |
GoldenEvaluationMetricsThresholds
| ייצוג ב-JSON |
|---|
{ "turnLevelMetricsThresholds": { object ( |
| שדות | |
|---|---|
turnLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של המדדים ברמת התור. |
expectationLevelMetricsThresholds |
זה שינוי אופציונלי. ערכי הסף של מדדי רמת הציפייה. |
toolMatchingSettings |
זה שינוי אופציונלי. הגדרות ההתאמה של הכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת. |
ToolMatchingSettings
| ייצוג ב-JSON |
|---|
{
"extraToolCallBehavior": enum ( |
| שדות | |
|---|---|
extraToolCallBehavior |
זה שינוי אופציונלי. התנהגות של קריאות נוספות לכלים. ברירת המחדל היא FAIL. |
EvaluationConfig
| ייצוג ב-JSON |
|---|
{ "inputAudioConfig": { object ( |
| שדות | |
|---|---|
inputAudioConfig |
זה שינוי אופציונלי. הגדרות לעיבוד האודיו שמתקבל. |
outputAudioConfig |
זה שינוי אופציונלי. הגדרות ליצירת פלט האודיו. |
evaluationChannel |
זה שינוי אופציונלי. הערוץ שרוצים לבדוק. |
toolCallBehaviour |
זה שינוי אופציונלי. מציין אם ההערכה צריכה להשתמש בקריאות אמיתיות לכלים או בכלים מזויפים. |
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
מייצג JSON null.
NullValue הוא ערך שמירה, שמשתמש בסוג enum עם ערך אחד בלבד כדי לייצג את ערך ה-null עבור איחוד הסוגים Value.
שדה מסוג NullValue עם ערך כלשהו שאינו 0 נחשב לא תקין. רוב הסריאליזטורים של ProtoJSON יפלטו Value עם null_value שמוגדר כ-JSON null בלי קשר לערך המספרי, ולכן יבצעו המרה הלוך ושוב לערך 0.
| טיפוסים בני מנייה (enum) | |
|---|---|
NULL_VALUE |
ערך null. |
ComparisonType
סוגי השוואות נתמכים לבדיקת התשובה של הסוכן.
| טיפוסים בני מנייה (enum) | |
|---|---|
COMPARISON_TYPE_UNSPECIFIED |
סוג ההשוואה לא צוין. ההתנהגות מוגדרת כברירת מחדל ל-SEMANTIC_SIMILARITY לתגובות של סוכנים ולקריאות כלים. |
EQUALS |
התאמה מדויקת של מחרוזת. |
CONTAINS |
התאמה של מחרוזת משנה (בדיקה אם המחרוזת הצפויה כלולה בתשובה בפועל). |
SEMANTIC_SIMILARITY |
התאמה של דמיון סמנטי (הערכת דמיון המשמעות באמצעות LLM). |
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 |
כשל במהלך סימולציית משתמש. |
סוג
סוג הטווח. יכול להיות שבעתיד נוסיף עוד ערכים.
| טיפוסים בני מנייה (enum) | |
|---|---|
TYPE_UNSPECIFIED |
ערך ברירת המחדל. הערך הזה לא בשימוש. |
TOOL |
טווח של קריאה לכלי. |
USER_CALLBACK |
טווח הזמן של בקשת השיחה מהמשתמש. |
GUARDRAIL |
טווח שכבת ההגנה. |
LLM |
טווח LLM. |
BackgroundEnvironment
סביבת אודיו מדומה.
| טיפוסים בני מנייה (enum) | |
|---|---|
BACKGROUND_ENVIRONMENT_UNSPECIFIED |
לא צוינה סביבת רקע. |
CALL_CENTER |
סביבת מוקד טלפוני. |
TRAFFIC |
סביבה עם רעשי תנועה. |
KIDS_NOISE |
סביבה רועשת של ילדים. |
CAFE |
סביבת בית קפה. |
ExecutionState
הסטטוס של הביצוע של תוצאת ההערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXECUTION_STATE_UNSPECIFIED |
לא צוין מצב הביצוע של תוצאת ההערכה. |
QUEUED |
ההפעלה של תוצאת ההערכה ממתינה בתור. |
RUNNING |
ההרצה של תוצאת ההערכה מתבצעת. |
COMPLETED |
ההרצה של תוצאת ההערכה הסתיימה. |
ERROR |
הביצוע של תוצאת ההערכה נכשל בגלל שגיאה פנימית. |
CANCELLED |
ההרצה של תוצאת ההערכה בוטלה. |
ExtraToolCallBehavior
הגדרת ההתנהגות כשנתקלים בקריאה נוספת לכלי. קריאה נוספת לכלי היא קריאה לכלי שקיימת בהרצה אבל לא תואמת לאף קריאה לכלי בציפייה המוזהבת.
| טיפוסים בני מנייה (enum) | |
|---|---|
EXTRA_TOOL_CALL_BEHAVIOR_UNSPECIFIED |
התנהגות לא מוגדרת. ברירת המחדל היא FAIL. |
FAIL |
הבדיקה תיכשל אם תזוהה קריאה נוספת לכלי. |
ALLOW |
מאשרים את השימוש בכלי הנוסף. |
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
הגדרת אופן הפעולה של קריאות לכלי בהרצות של הערכה.
| טיפוסים בני מנייה (enum) | |
|---|---|
EVALUATION_TOOL_CALL_BEHAVIOUR_UNSPECIFIED |
התנהגות לא מוגדרת של קריאה לכלי. ברירת המחדל תהיה הפעלת כלים אמיתיים. |
REAL |
להשתמש בקריאות אמיתיות לכלים. |
FAKE |
שימוש בקריאות מזויפות לכלים. |
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, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.
רמז הרסני: ❌ | רמז אידמפוטנטי: ❌ | רמז לקריאה בלבד: ❌ | רמז לעולם פתוח: ❌