אינדקס
-
A2AService(ממשק) -
APIKeySecurityScheme(הודעה) -
AgentCapabilities(הודעה) -
AgentCard(הודעה) -
AgentCardSignature(הודעה) -
AgentExtension(הודעה) -
AgentInterface(הודעה) -
AgentProvider(הודעה) -
AgentSkill(הודעה) -
Artifact(הודעה) -
AuthenticationInfo(הודעה) -
AuthorizationCodeOAuthFlow(הודעה) -
CancelTaskRequest(הודעה) -
ClientCredentialsOAuthFlow(הודעה) -
DeleteTaskPushNotificationConfigRequest(הודעה) -
DeviceCodeOAuthFlow(הודעה) -
GetExtendedAgentCardRequest(הודעה) -
GetTaskPushNotificationConfigRequest(הודעה) -
GetTaskRequest(הודעה) -
HTTPAuthSecurityScheme(הודעה) -
ImplicitOAuthFlow(הודעה) -
ListTaskPushNotificationConfigsRequest(הודעה) -
ListTaskPushNotificationConfigsResponse(הודעה) -
ListTasksRequest(הודעה) -
ListTasksResponse(הודעה) -
Message(הודעה) -
MutualTlsSecurityScheme(הודעה) -
OAuth2SecurityScheme(הודעה) -
OAuthFlows(הודעה) -
OpenIdConnectSecurityScheme(הודעה) -
Part(הודעה) -
PasswordOAuthFlow(הודעה) Role(enum)-
SecurityRequirement(הודעה) -
SecurityScheme(הודעה) -
SendMessageConfiguration(הודעה) -
SendMessageRequest(הודעה) -
SendMessageResponse(הודעה) -
StreamResponse(הודעה) -
StringList(הודעה) -
SubscribeToTaskRequest(הודעה) -
Task(הודעה) -
TaskArtifactUpdateEvent(הודעה) -
TaskPushNotificationConfig(הודעה) TaskState(enum)-
TaskStatus(הודעה) -
TaskStatusUpdateEvent(הודעה)
A2AService
מספק פעולות לאינטראקציה עם סוכנים באמצעות פרוטוקול A2A.
| CancelTask |
|---|
|
ביטול משימה בתהליך.
|
| CreateTaskPushNotificationConfig |
|---|
|
יצירת הגדרת התראות למשימה.
|
| DeleteTaskPushNotificationConfig |
|---|
|
מחיקת הגדרת התראה על משימה.
|
| GetExtendedAgentCard |
|---|
|
מקבל את כרטיס הסוכן המורחב של הסוכן המאומת.
|
| GetTask |
|---|
|
מקבל את הסטטוס העדכני של משימה.
|
| GetTaskPushNotificationConfig |
|---|
|
מקבלים הגדרת התראה בדחיפה למשימה.
|
| ListTaskPushNotificationConfigs |
|---|
|
אחזור רשימה של התראות פוש שהוגדרו למשימה.
|
| ListTasks |
|---|
|
מציג רשימה של משימות שתואמות למסנן שצוין.
|
| SendMessage |
|---|
|
שליחת הודעה לנציג.
|
| SendStreamingMessage |
|---|
|
שולחת הודעת סטרימינג לסוכן, כדי לאפשר אינטראקציה בזמן אמת ועדכוני סטטוס. גרסת סטרימינג של
|
| SubscribeToTask |
|---|
|
המשתמש נרשם לקבלת עדכונים על משימות שלא נמצאות במצב סופי. הפונקציה מחזירה
|
APIKeySecurityScheme
הגדרת תוכנית אבטחה באמצעות מפתח API.
| שדות | |
|---|---|
description |
תיאור אופציונלי של תוכנית האבטחה. |
location |
חובה. המיקום של מפתח ה-API. הערכים התקינים הם query, header או cookie. |
name |
חובה. השם של הפרמטר של הכותרת, השאילתה או קובץ ה-Cookie שבו רוצים להשתמש. |
AgentCapabilities
מגדיר יכולות אופציונליות שסוכן תומך בהן.
| שדות | |
|---|---|
extensions[] |
רשימה של הרחבות פרוטוקול שהסוכן תומך בהן. |
streaming |
מציין אם הסוכן תומך בתגובות סטרימינג. |
push_notifications |
ההגדרה מציינת אם הסוכן תומך בשליחת התראות על עדכונים של משימות אסינכרוניות. |
extended_agent_card |
מציין אם הסוכן תומך באספקת כרטיס סוכן מורחב לאחר אימות. |
AgentCard
מניפסט עם תיאור עצמי של סוכן. הוא מספק מטא-נתונים חיוניים, כולל זהות הסוכן, היכולות, הכישורים, שיטות התקשורת הנתמכות ודרישות האבטחה. המזהה הבא: 20
| שדות | |
|---|---|
name |
חובה. שם הסוכן שקריא לאנשים. דוגמה: "סוכן מתכונים" |
description |
חובה. תיאור של הסוכן שאנשים יכולים לקרוא, כדי לעזור למשתמשים ולסוכנים אחרים להבין את המטרה שלו. דוגמה: "סוכן שעוזר למשתמשים במתכונים ובבישול". |
supported_interfaces[] |
חובה. רשימה מסודרת של ממשקים נתמכים. עדיף להשתמש ברשומה הראשונה. |
provider |
ספק השירות של הסוכן. |
version |
חובה. גרסת הסוכן. דוגמה: "1.0.0" |
capabilities |
חובה. קבוצת היכולות A2A שנתמכת על ידי הסוכן. |
security_schemes |
פרטי תוכנית האבטחה שמשמשים לאימות מול הסוכן הזה. |
security_requirements[] |
דרישות אבטחה ליצירת קשר עם הסוכן. |
default_input_modes[] |
נדרש. protolint:enable REPEATED_FIELD_NAMES_PLURALIZED קבוצת מצבי האינטראקציה שהסוכן תומך בהם בכל הכישורים. אפשר לשנות את הגדרות ברירת המחדל לכל מיומנות. מוגדר כסוגי מדיה. |
default_output_modes[] |
חובה. סוגי המדיה הנתמכים כפלט מהסוכן הזה. |
skills[] |
חובה. סקילים מייצגים את היכולות של סוכן. זהו בעיקר מושג תיאורי, אבל הוא מייצג קבוצה ממוקדת יותר של התנהגויות שהסוכן צפוי להצליח בהן. |
signatures[] |
חתימות אינטרנט מבוססות JSON שחושבו עבור |
documentation_url |
כתובת URL שכוללת מסמכים נוספים על הסוכן. |
icon_url |
זה שינוי אופציונלי. כתובת URL לסמל של הסוכן. |
AgentCardSignature
AgentCardSignature מייצג חתימת JWS של AgentCard. הפורמט הזה תואם לפורמט JSON של חתימת רשת מבוססת JSON (JWS) של RFC 7515.
| שדות | |
|---|---|
protected |
חובה. חובה. כותרת ה-JWS המוגנת של החתימה. זה תמיד אובייקט JSON בקידוד base64url. |
signature |
חובה. החתימה המחושבת, בקידוד base64url. |
header |
ערכי הכותרת של JWS לא מוגן. |
AgentExtension
הצהרה על הרחבת פרוטוקול שנתמכת על ידי סוכן.
| שדות | |
|---|---|
uri |
מזהה משאבים אחיד (URI) ייחודי שמזהה את התוסף. |
description |
תיאור קריא לאנשים של אופן השימוש של הסוכן בתוסף. |
required |
אם הערך הוא True, הלקוח חייב להבין את הדרישות של התוסף ולפעול בהתאם להן. |
params |
זה שינוי אופציונלי. פרמטרים להגדרה ספציפית של תוסף. |
AgentInterface
ההגדרה הזו מכריזה על שילוב של כתובת יעד, אמצעי תחבורה וגרסת פרוטוקול לאינטראקציה עם הסוכן. כך סוכנים יכולים לחשוף את אותה פונקציונליות באמצעות מנגנונים שונים של קישור פרוטוקולים.
| שדות | |
|---|---|
url |
חובה. כתובת ה-URL שבה הממשק הזה זמין. זו צריכה להיות כתובת URL מוחלטת ותקינה מסוג HTTPS בסביבת הייצור. דוגמה: "https://api.example.com/a2a/v1", "https://grpc.example.com/a2a" |
protocol_binding |
חובה. הקישור לפרוטוקול שנתמך בכתובת ה-URL הזו. זהו מחרוזת טופס פתוחה, שאפשר להרחיב אותה בקלות לקישורי פרוטוקולים אחרים. הפורמטים העיקריים שנתמכים באופן רשמי הם |
tenant |
זה שינוי אופציונלי. מחרוזת אטומה שמשמשת לניתוב בקשות לסוכן או לדייר ספציפיים כשכמה סוכנים מוגשים מאחורי נקודת קצה יחידה של A2A. אם הערך מוגדר, הלקוחות חייבים לכלול אותו בשדה |
protocol_version |
חובה. הגרסה של פרוטוקול A2A שהממשק הזה חושף. מומלץ להשתמש בגרסה המשנית הנתמכת האחרונה לכל גרסה ראשית. דוגמאות: 0.3, 1.0 |
AgentProvider
מייצג את ספק השירות של סוכן.
| שדות | |
|---|---|
url |
חובה. כתובת URL של אתר האינטרנט של ספק הסוכן או של מסמכים רלוונטיים. דוגמה: "https://ai.google.dev" |
organization |
חובה. השם של הארגון של ספק הסוכן. דוגמה: Google |
AgentSkill
מייצג יכולת או פונקציה ייחודית שהנציג יכול לבצע.
| שדות | |
|---|---|
id |
חובה. מזהה ייחודי של מיומנות הסוכן. |
name |
חובה. שם של המיומנות שקריא לאנשים. |
description |
חובה. תיאור מפורט של המיומנות. |
tags[] |
חובה. קבוצה של מילות מפתח שמתארות את היכולות של המיומנות. |
examples[] |
דוגמאות לפרומפטים או לתרחישים שהמיומנות הזו יכולה לטפל בהם. |
input_modes[] |
קבוצת סוגי המדיה הנתמכים של הקלט למיומנות הזו, שדוחפת את ברירות המחדל של הסוכן. |
output_modes[] |
קבוצת סוגי המדיה הנתמכים של הפלט במיומנות הזו, שדוחפת את ברירות המחדל של הסוכן. |
security_requirements[] |
תוכניות אבטחה שנדרשות לשימוש במיומנות הזו. |
ארטיפקט
ארטיפקטים מייצגים את הפלט של המשימה.
| שדות | |
|---|---|
artifact_id |
חובה. מזהה ייחודי (למשל UUID) של הארטיפקט. הוא חייב להיות ייחודי בתוך משימה. |
name |
שם של הארטיפקט שקריא לאנשים. |
description |
זה שינוי אופציונלי. תיאור קריא (לבני אדם) של הארטיפקט. |
parts[] |
חובה. התוכן של הארטיפקט. צריך להכיל לפחות חלק אחד. |
metadata |
זה שינוי אופציונלי. מטא-נתונים שכלולים בארטיפקט. |
extensions[] |
כתובות ה-URI של התוספים שקיימים בארטיפקט הזה או שתורמים לו. |
AuthenticationInfo
הגדרת פרטי אימות שמשמשים להתראות פוש.
| שדות | |
|---|---|
scheme |
חובה. סכמת אימות HTTP ממאגר IANA. דוגמאות: |
credentials |
פרטי הכניסה של ההתראות. הפורמט תלוי בסכימה (למשל, טוקן ל-Bearer). |
AuthorizationCodeOAuthFlow
הגדרת פרטים של תהליך הרשאה באמצעות קוד של OAuth 2.0.
| שדות | |
|---|---|
authorization_url |
חובה. כתובת ה-URL לאישור שתשמש בתהליך הזה. |
token_url |
חובה. כתובת ה-URL של האסימון שתשמש בתהליך הזה. |
refresh_url |
כתובת ה-URL שתשמש להשגת טוקנים לרענון. |
scopes |
חובה. היקפי ההרשאות שזמינים לתוכנית האבטחה OAuth2. |
pkce_required |
מציין אם נדרש PKCE (RFC 7636) בתהליך הזה. תמיד צריך להשתמש ב-PKCE עבור לקוחות ציבוריים, ומומלץ להשתמש בו עבור כל הלקוחות. |
CancelTaskRequest
מייצג בקשה לשיטת CancelTask.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
id |
חובה. מזהה המשאב של המשימה שרוצים לבטל. |
metadata |
מפת מפתח/ערך גמישה להעברת הקשר או פרמטרים נוספים. |
ClientCredentialsOAuthFlow
הגדרת פרטי ההגדרה של תהליך פרטי הכניסה של לקוח OAuth 2.0.
| שדות | |
|---|---|
token_url |
חובה. כתובת ה-URL של האסימון שתשמש בתהליך הזה. |
refresh_url |
כתובת ה-URL שתשמש להשגת טוקנים לרענון. |
scopes |
חובה. היקפי ההרשאות שזמינים לתוכנית האבטחה OAuth2. |
DeleteTaskPushNotificationConfigRequest
מייצג בקשה לשיטת DeleteTaskPushNotificationConfig.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
task_id |
חובה. מזהה מקור המידע של משימת ההורה. |
id |
חובה. מזהה המשאב של ההגדרה למחיקה. |
DeviceCodeOAuthFlow
הגדרת פרטי התצורה של תהליך קוד המכשיר של OAuth 2.0 (RFC 8628). התהליך הזה מיועד למכשירים עם מגבלות על הקלט, כמו מכשירי IoT וכלי CLI שבהם המשתמש מאמת את עצמו במכשיר נפרד.
| שדות | |
|---|---|
device_authorization_url |
חובה. כתובת ה-URL של נקודת הקצה להרשאה של המכשיר. |
token_url |
חובה. כתובת ה-URL של האסימון שתשמש בתהליך הזה. |
refresh_url |
כתובת ה-URL שתשמש להשגת טוקנים לרענון. |
scopes |
חובה. היקפי ההרשאות שזמינים לתוכנית האבטחה OAuth2. |
GetExtendedAgentCardRequest
מייצג בקשה לשיטת GetExtendedAgentCard.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
GetTaskPushNotificationConfigRequest
מייצג בקשה לשיטת GetTaskPushNotificationConfig.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
task_id |
חובה. מזהה מקור המידע של משימת ההורה. |
id |
חובה. מזהה מקור המידע של ההגדרה שרוצים לאחזר. |
GetTaskRequest
מייצג בקשה לשיטת GetTask.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
id |
חובה. מזהה המשאב של המשימה שאותה רוצים לאחזר. |
history_length |
המספר המקסימלי של ההודעות האחרונות מההיסטוריה של המשימה לאחזור. אם לא מוגדר ערך, המשמעות היא שהלקוח לא מטיל מגבלה כלשהי. ערך של אפס מציין בקשה לא לכלול הודעות. השרת לא יכול להחזיר יותר הודעות מהערך שסופק, אבל הוא יכול להחיל מגבלה נמוכה יותר. |
HTTPAuthSecurityScheme
הגדרה של סכמת אבטחה באמצעות אימות HTTP.
| שדות | |
|---|---|
description |
תיאור אופציונלי של תוכנית האבטחה. |
scheme |
חובה. השם של סכמת האימות של HTTP שבה יש להשתמש בכותרת Authorization, כפי שמוגדר ב-RFC7235 (למשל, Bearer). הערך הזה צריך להיות רשום במאגר של IANA Authentication Scheme. |
bearer_format |
רמז ללקוח לזיהוי הפורמט של אסימון ה-Bearer (למשל, JWT). בעיקר למטרות תיעוד. |
ImplicitOAuthFlow
הוצא משימוש: במקומו יש להשתמש בקוד הרשאה + PKCE.
| שדות | |
|---|---|
authorization_url |
כתובת ה-URL לאישור שתשמש בתהליך הזה. הערך חייב להיות בפורמט של כתובת URL. תקן OAuth2 מחייב שימוש ב-TLS |
refresh_url |
כתובת ה-URL שתשמש להשגת טוקנים לרענון. הערך חייב להיות בפורמט של כתובת URL. התקן OAuth2 מחייב שימוש ב-TLS. |
scopes |
היקפי ההרשאות שזמינים לתוכנית האבטחה OAuth2. מיפוי בין שם ההיקף לבין תיאור קצר שלו. יכול להיות שהמפה תהיה ריקה. |
ListTaskPushNotificationConfigsRequest
מייצג בקשה לשיטת ListTaskPushNotificationConfigs.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
task_id |
חובה. מזהה משאב המשימה ברמת ההורה. |
page_size |
מספר ההגדרות המקסימלי שיוחזרו. |
page_token |
טוקן של דף שהתקבל מקריאה קודמת של |
ListTaskPushNotificationConfigsResponse
מייצג תגובה תקינה לשיטת ListTaskPushNotificationConfigs.
| שדות | |
|---|---|
configs[] |
רשימת ההגדרות של ההתראות. |
next_page_token |
אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין יותר תוצאות ברשימה. |
ListTasksRequest
פרמטרים להצגת רשימת משימות עם קריטריוני סינון אופציונליים.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
context_id |
אפשר לסנן את המשימות לפי מזהה ההקשר כדי לקבל משימות משיחה או מפגישה ספציפית. |
status |
סינון משימות לפי הסטטוס הנוכחי שלהן. |
page_token |
טוקן של דף שהתקבל מקריאה קודמת של |
status_timestamp_after |
סינון משימות שהסטטוס שלהן עודכן אחרי חותמת הזמן שצוינה בפורמט ISO 8601 (למשל, 2023-10-27T10:00:00Z). יוחזרו רק משימות שחותמת הזמן של הסטטוס שלהן גדולה מהערך הזה או שווה לו. |
page_size |
מספר המשימות המקסימלי שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים ערך, יוחזרו לכל היותר 50 משימות. הערך המינימלי הוא 1. הערך המקסימלי הוא 100. |
history_length |
מספר ההודעות המקסימלי שייכללו בהיסטוריה של כל משימה. |
include_artifacts |
האם לכלול ארטיפקטים במשימות שמוחזרות. ברירת המחדל היא false כדי להקטין את גודל המטען הייעודי (payload). |
ListTasksResponse
אובייקט התוצאה של שיטת ListTasks שמכיל מערך של משימות ומידע על חלוקה לדפים.
| שדות | |
|---|---|
tasks[] |
חובה. מערך של משימות שתואמות לקריטריונים שצוינו. |
next_page_token |
חובה. אסימון לאחזור של דף התוצאות הבא, או ערך ריק אם אין יותר תוצאות ברשימה. |
page_size |
חובה. גודל הדף ששימש ליצירת התשובה הזו. |
total_size |
חובה. המספר הכולל של המשימות שזמינות (לפני חלוקה לדפים). |
הודעה
Message היא יחידת תקשורת אחת בין הלקוח לשרת. הוא יכול להיות משויך להקשר או למשימה. בהודעות מהשרת, צריך לספק את context_id, ואת task_id רק אם נוצרה משימה. בהודעות של לקוחות, שני השדות הם אופציונליים, אבל אם מספקים את שניהם, הם צריכים להיות זהים (הערך של context_id צריך להיות זה שמוגדר במשימה). אם מספקים רק את task_id, השרת יסיק את context_id מתוכו.
| שדות | |
|---|---|
message_id |
חובה. המזהה הייחודי (למשל UUID) של ההודעה. הוא נוצר על ידי יוצר ההודעה. |
context_id |
זה שינוי אופציונלי. מזהה ההקשר של ההודעה. אם מוגדר, ההודעה תשויך להקשר שצוין. |
task_id |
זה שינוי אופציונלי. מזהה המשימה של ההודעה. אם תוגדר משימה, ההודעה תשויך למשימה שצוינה. |
role |
חובה. מזהה את השולח של ההודעה. |
parts[] |
חובה. Parts הוא מאגר של תוכן ההודעה. |
metadata |
זה שינוי אופציונלי. מטא-נתונים שרוצים לספק יחד עם ההודעה. |
extensions[] |
כתובות ה-URI של התוספים שקיימים בהודעה הזו או שתרמו להודעה הזו. |
reference_task_ids[] |
רשימה של מזהי משימות שההודעה הזו מפנה אליהם כדי לספק הקשר נוסף. |
MutualTlsSecurityScheme
הגדרה של תוכנית אבטחה באמצעות אימות mTLS.
| שדות | |
|---|---|
description |
תיאור אופציונלי של תוכנית האבטחה. |
OAuth2SecurityScheme
הגדרת תוכנית אבטחה באמצעות OAuth 2.0.
| שדות | |
|---|---|
description |
תיאור אופציונלי של תוכנית האבטחה. |
flows |
חובה. אובייקט שמכיל פרטי הגדרות של תהליכי OAuth 2.0 הנתמכים. |
oauth2_metadata_url |
כתובת ה-URL של המטא-נתונים של שרת ההרשאות ב-OAuth2 RFC 8414. נדרש פרוטוקול TLS. |
OAuthFlows
ההגדרה הזו מגדירה את התצורה של תהליכי OAuth 2.0 הנתמכים.
| שדות | |
|---|---|
שדה איחוד הערך |
|
authorization_code |
הגדרות לתהליך הרשאה באמצעות קוד של OAuth. |
client_credentials |
הגדרות לתהליך OAuth Client Credentials. |
implicit |
הוצא משימוש: במקומו יש להשתמש בקוד הרשאה + PKCE. |
password |
הוצא משימוש: צריך להשתמש בקוד הרשאה + PKCE או בקוד מכשיר. |
device_code |
הגדרה של תהליך קוד המכשיר ב-OAuth. |
OpenIdConnectSecurityScheme
הגדרת תוכנית אבטחה באמצעות OpenID Connect.
| שדות | |
|---|---|
description |
תיאור אופציונלי של תוכנית האבטחה. |
open_id_connect_url |
חובה. כתובת URL של מסמך Discovery של OpenID Connect למטא-נתונים של ספק OIDC. |
חלק
Part מייצג מאגר של קטע מתוכן תקשורת. החלקים יכולים להיות טקסט בלבד, קובץ כלשהו (תמונה, סרטון וכו') או blob של נתונים מובנים (כלומר JSON).
| שדות | |
|---|---|
metadata |
אופציונלי. מטא-נתונים שמשויכים לחלק הזה. |
filename |
שם קובץ אופציונלי |
media_type |
|
שדה איחוד הערך |
|
text |
תוכן המחרוזת של החלק |
raw |
תוכן הקובץ בבייט |
url |
|
data |
|
PasswordOAuthFlow
הוצא משימוש: צריך להשתמש בקוד הרשאה + PKCE או בקוד מכשיר.
| שדות | |
|---|---|
token_url |
כתובת ה-URL של האסימון שתשמש בתהליך הזה. הערך חייב להיות בפורמט של כתובת URL. התקן OAuth2 מחייב שימוש ב-TLS. |
refresh_url |
כתובת ה-URL שתשמש להשגת טוקנים לרענון. הערך חייב להיות בפורמט של כתובת URL. התקן OAuth2 מחייב שימוש ב-TLS. |
scopes |
היקפי ההרשאות שזמינים לתוכנית האבטחה OAuth2. מיפוי בין שם ההיקף לבין תיאור קצר שלו. יכול להיות שהמפה תהיה ריקה. |
תפקיד
השדה הזה מגדיר את השולח של הודעה בתקשורת בפרוטוקול A2A.
| טיפוסים בני מנייה (enum) | |
|---|---|
ROLE_UNSPECIFIED |
התפקיד לא צוין. |
ROLE_USER |
ההודעה נשלחת מהלקוח לשרת. |
ROLE_AGENT |
ההודעה נשלחת מהשרת ללקוח. |
SecurityRequirement
הגדרת דרישות האבטחה של סוכן.
| שדות | |
|---|---|
schemes |
מפה של תוכניות אבטחה להיקפים הנדרשים. |
SecurityScheme
הגדרת תוכנית אבטחה שאפשר להשתמש בה כדי לאבטח את נקודות הקצה של סוכן. זהו סוג של איחוד מובחן שמבוסס על אובייקט של תוכנית אבטחה ב-OpenAPI 3.2. למידע נוסף: https://spec.openapis.org/oas/v3.2.0.html#security-scheme-object
| שדות | |
|---|---|
שדה איחוד הערך |
|
api_key_security_scheme |
אימות מבוסס-מפתח API. |
http_auth_security_scheme |
אימות HTTP (בסיסי, Bearer וכו'). |
oauth2_security_scheme |
אימות OAuth 2.0. |
open_id_connect_security_scheme |
אימות OpenID Connect. |
mtls_security_scheme |
אימות TLS בו-זמני (mTLS). |
SendMessageConfiguration
הגדרת בקשה לשליחת הודעה.
| שדות | |
|---|---|
accepted_output_modes[] |
רשימה של סוגי מדיה שהלקוח מוכן לקבל עבור חלקי התשובה. הסוכנים צריכים להשתמש במידע הזה כדי להתאים את הפלט שלהם. |
task_push_notification_config |
הגדרות שמאפשרות לסוכן לשלוח התראות על עדכונים במשימות. כששולחים את ההגדרה הזו בבקשת |
return_immediately |
אם |
history_length |
המספר המקסימלי של ההודעות האחרונות מההיסטוריה של המשימה שיוחזרו בתשובה. אם לא מוגדר ערך, המשמעות היא שהלקוח לא מטיל מגבלה כלשהי. ערך של אפס מציין בקשה לא לכלול הודעות. השרת לא יכול להחזיר יותר הודעות מהערך שסופק, אבל הוא יכול להחיל מגבלה נמוכה יותר. |
SendMessageRequest
מייצג בקשה לשיטת SendMessage.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
message |
חובה. ההודעה שרוצים לשלוח לנציג. |
configuration |
הגדרות לבקשת השליחה. |
metadata |
מפת מפתח/ערך גמישה להעברת הקשר או פרמטרים נוספים. |
SendMessageResponse
מייצג את התשובה ל-method SendMessage.
| שדות | |
|---|---|
שדה איחוד payload. המטען הייעודי (payload) של התשובה. הערך payload יכול להיות רק אחד מהבאים: |
|
task |
המשימה שנוצרה או עודכנה על ידי ההודעה. |
message |
הודעה מהסוכן. |
StreamResponse
אובייקט wrapper שמשמש בפעולות סטרימינג כדי להכיל סוגים שונים של נתוני תגובה.
| שדות | |
|---|---|
שדה איחוד payload. המטען הייעודי (payload) של תשובת הסטרימינג. הערך payload יכול להיות רק אחד מהבאים: |
|
task |
אובייקט Task שמכיל את המצב הנוכחי של המשימה. |
message |
אובייקט Message שמכיל הודעה מהסוכן. |
status_update |
אירוע שמציין עדכון של סטטוס המשימה. |
artifact_update |
אירוע שמציין עדכון של פריט מידע שנוצר בתהליך פיתוח (Artifact) של משימה. |
StringList
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
| שדות | |
|---|---|
list[] |
ערכי המחרוזות הנפרדים. |
SubscribeToTaskRequest
מייצג בקשה לשיטת SubscribeToTask.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
id |
חובה. מזהה מקור המידע של המשימה שאליה רוצים להירשם. |
משימה
Task היא יחידת הפעולה העיקרית ב-A2A. יש לו סטטוס נוכחי, וכשנוצרות תוצאות למשימה, הן נשמרות בארטיפקט. אם יש כמה תורות למשימה, הן מאוחסנות בהיסטוריה.
| שדות | |
|---|---|
id |
חובה. מזהה ייחודי (למשל UUID) של המשימה, שנוצר על ידי השרת למשימה חדשה. |
context_id |
מזהה ייחודי (למשל UUID) של אוסף ההקשרים של האינטראקציות (משימות והודעות). |
status |
חובה. הסטטוס הנוכחי של |
artifacts[] |
קבוצה של פריטי מידע שנוצר בתהליך הפיתוח (Artifact) של הפלט בשביל |
history[] |
protolint:disable REPEATED_FIELD_NAMES_PLURALIZED היסטוריית האינטראקציות מ |
metadata |
protolint:enable REPEATED_FIELD_NAMES_PLURALIZED אובייקט של מפתח/ערך לאחסון מטא-נתונים מותאמים אישית לגבי משימה. |
TaskArtifactUpdateEvent
דלתא של משימה שבה נוצר ארטיפקט.
| שדות | |
|---|---|
task_id |
חובה. המזהה של המשימה של הארטיפקט הזה. |
context_id |
חובה. המזהה של ההקשר שאליו המשימה הזו שייכת. |
artifact |
חובה. הארטיפקט שנוצר או עודכן. |
append |
אם הערך הוא true, התוכן של פריט המידע הזה שנוצר בתהליך פיתוח (Artifact) יצורף לפריט מידע שנשלח קודם עם אותו מזהה. |
last_chunk |
אם הערך הוא true, זהו החלק האחרון של הארטיפקט. |
metadata |
זה שינוי אופציונלי. מטא-נתונים שמשויכים לעדכון הארטיפקט. |
TaskPushNotificationConfig
מאגר שמשייך הגדרה של התראה בדחיפה למשימה ספציפית.
| שדות | |
|---|---|
tenant |
זה שינוי אופציונלי. מזהה ניתוב אטום. הערך חייב להיות זהה לערך |
id |
פרטי ההגדרה של ההתראה. מזהה ייחודי (למשל UUID) של הגדרת ההתראה בדחיפה הזו. |
task_id |
המזהה של המשימה שההגדרה הזו משויכת אליה. |
url |
חובה. כתובת ה-URL שאליה צריך לשלוח את ההתראה. |
token |
טוקן ייחודי למשימה או לסשן הזה. |
authentication |
נדרשים פרטי אימות כדי לשלוח את ההתראה. |
TaskState
המאפיין הזה מגדיר את מצבי מחזור החיים האפשריים של Task.
| טיפוסים בני מנייה (enum) | |
|---|---|
TASK_STATE_UNSPECIFIED |
סטטוס המשימה לא ידוע או לא ברור. |
TASK_STATE_SUBMITTED |
מציין שהמשימה נשלחה ואושרה. |
TASK_STATE_WORKING |
מציין שהסוכן מעבד באופן פעיל משימה. |
TASK_STATE_COMPLETED |
מציין שמשימה הסתיימה בהצלחה. זהו מצב סופי. |
TASK_STATE_FAILED |
מציין שמשימה הסתיימה עם שגיאה. זהו מצב סופי. |
TASK_STATE_CANCELED |
מציין שמשימה בוטלה לפני שהושלמה. זהו מצב סופי. |
TASK_STATE_INPUT_REQUIRED |
מציין שהסוכן צריך קלט של משתמשים נוסף כדי להמשיך. זהו מצב של הפרעה. |
TASK_STATE_REJECTED |
מציין שהסוכן החליט לא לבצע את המשימה. אפשר לעשות את זה במהלך יצירת המשימה הראשונית או בשלב מאוחר יותר, אחרי שהסוכן קובע שהוא לא יכול להמשיך או שהוא לא ימשיך. זהו מצב סופי. |
TASK_STATE_AUTH_REQUIRED |
הסמל הזה מציין שנדרש אימות כדי להמשיך. זהו מצב של הפרעה. |
TaskStatus
מאגר לסטטוס של משימה
| שדות | |
|---|---|
state |
חובה. המצב הנוכחי של המשימה. |
message |
הודעה שמשויכת לסטטוס. |
timestamp |
חותמת זמן בפורמט ISO 8601 של מועד התיעוד של הסטטוס. דוגמה: "2023-10-27T10:00:00Z" |
TaskStatusUpdateEvent
אירוע שנשלח על ידי הסוכן כדי להודיע ללקוח על שינוי בסטטוס של משימה.
| שדות | |
|---|---|
task_id |
חובה. המזהה של המשימה שהשתנה. |
context_id |
חובה. המזהה של ההקשר שאליו המשימה שייכת. |
status |
חובה. הסטטוס החדש של המשימה. |
metadata |
זה שינוי אופציונלי. מטא-נתונים שמשויכים לעדכון המשימה. |