הודעה בשיחה.
| ייצוג 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 |
מבנה נתונים מייצג משתני ברירת מחדל בתחילת השיחה, עם מפתחות לפי שמות המשתנים. |
Blob
מייצג קלט או פלט של blob בשיחה.
| ייצוג JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME התקני של IANA של נתוני המקור. |
data |
חובה. בייטים גולמיים של ה-blob. מחרוזת בקידוד Base64. |
תמונה
מייצג קלט או פלט של תמונה בשיחה.
| ייצוג JSON |
|---|
{ "mimeType": string, "data": string } |
| שדות | |
|---|---|
mimeType |
חובה. סוג ה-MIME התקני של IANA של נתוני המקור. סוגי התמונות הנתמכים כוללים: * image/png * image/jpeg * image/webp |
data |
חובה. בייטים גולמיים של התמונה. מחרוזת בקידוד Base64. |
ToolCall
מבקשים מהלקוח או מהסוכן להפעיל את הכלי שצוין.
| ייצוג JSON |
|---|
{ "id": string, "displayName": string, "args": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. המזהה הייחודי של קריאת הכלי. אם השדה מאוכלס, הלקוח צריך להחזיר את תוצאת ההפעלה עם המזהה התואם בשדה |
displayName |
פלט בלבד. השם המוצג של הכלי. |
args |
זה שינוי אופציונלי. פרמטרי הקלט והערכים של הכלי בפורמט אובייקט JSON. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID. |
שדה איחוד tool_identifier. המזהה של הכלי להפעלה. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי להפעלה. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי להרצה בערכת הכלים. |
ToolsetTool
כלי שנוצר מתוך ערכת כלים.
| ייצוג JSON |
|---|
{ "toolset": string, "toolId": string } |
| שדות | |
|---|---|
toolset |
חובה. שם המשאב של ערכת הכלים שממנה נגזר הכלי הזה. פורמט: |
toolId |
זה שינוי אופציונלי. מזהה הכלי לסינון הכלים כדי לאחזר את הסכימה שלהם. |
ToolResponse
תוצאת ההפעלה של כלי ספציפי מהלקוח או מהסוכן.
| ייצוג JSON |
|---|
{ "id": string, "displayName": string, "response": { object }, "parentToolCallId": string, "agentName": string, // Union field |
| שדות | |
|---|---|
id |
זה שינוי אופציונלי. מזהה התשובה התואם של |
displayName |
פלט בלבד. השם המוצג של הכלי. |
response |
חובה. תוצאת ההפעלה של הכלי בפורמט אובייקט JSON. משתמשים במפתח 'output' כדי לציין את התגובה של הכלי ובמפתח 'error' כדי לציין את פרטי השגיאה (אם יש). אם לא מציינים את המפתחות 'פלט' ו'שגיאה', המערכת מתייחסת לכל התגובה כתוצאה של הפעלת הכלי. |
parentToolCallId |
פלט בלבד. המזהה של קריאת הכלי שגרמה לקריאה הזו, כשהיא הונפקה על ידי סוכן משנה שפועל בשם קריאת הורה. השדה ריק עבור שיחות ברמה העליונה. מאפשר ללקוח לקבץ את העבודה של סוכן משנה תחת השיחה שהתחילה אותה, במקום להציג כל שלב כפריט באותה רמה. |
agentName |
פלט בלבד. השם של הסוכן שהנפיק את השיחה הזו, בפורמט שקריא לבני אדם, למשל Contract Architect. השדה ריק אם הסוכן הבסיסי הנפיק את ה-ID. |
שדה איחוד tool_identifier. המזהה של הכלי שהופעל. יכול להיות שמדובר בכלי קבוע או בכלי מתוך ערכת כלים. הערך tool_identifier יכול להיות רק אחד מהבאים: |
|
tool |
זה שינוי אופציונלי. שם הכלי להפעלה. פורמט: |
toolsetTool |
זה שינוי אופציונלי. הכלי בערכת הכלים שהופעל. |
AgentTransfer
מייצג אירוע שמציין העברה של שיחה לסוכן אחר.
| ייצוג JSON |
|---|
{ "targetAgent": string, "displayName": string } |
| שדות | |
|---|---|
targetAgent |
חובה. הסוכן שאליו מועברת השיחה. הנציג יטפל בשיחה מעכשיו והלאה. פורמט: |
displayName |
פלט בלבד. השם המוצג של הסוכן. |