פעולות ממושכות

חלק מהשיטות של Dialogflow API מחזירות פעולה ממושכת. ה-methods האלה הן אסינכרוניות, ויכול להיות שהפעולה לא תושלם כשה-method תחזיר תשובה. אתם יכולים לבדוק את הסטטוס של הפעולות או לבטל אותן.

קבלת סטטוס הפעולה

כך בודקים את סטטוס הפעולה: אם יש הרבה פעולות שצריך לבדוק, כדאי להשתמש ב-הגבלת קצב של יצירת בקשות עבור הקריאות או להשתמש ב-method‏ list במקום זאת.

REST

מפעילים את ה-method‏ get לסוג Operations.

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

• ‫PROJECT_ID: מזהה הפרויקט ב-GCP
• ‫OPERATION_ID: מזהה הפעולה
• ‫API_VERSION: v2 או v2beta1

ה-method של ה-HTTP וכתובת ה-URL:

GET https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID

כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:

‫Curl (Linux,‏ macOS או Cloud Shell)

הערה: הפקודה הבאה מבוססת על ההנחה שנכנסתם ל-CLI של gcloud באמצעות חשבון המשתמש שלכם, על ידי הרצת gcloud init או gcloud auth login, או באמצעות Cloud Shell שמחבר אתכם אוטומטית ל-CLI של gcloud. כדי לבדוק איזה חשבון פעיל, אפשר להריץ את הפקודה gcloud auth list.

מריצים את הפקודה הבאה:

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "x-goog-user-project: PROJECT_ID" \
     "https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID"

‎PowerShell (Windows)

הערה: הפקודה הבאה מבוססת על ההנחה שנכנסתם ל-CLI של gcloud באמצעות חשבון המשתמש שלכם, על ידי הרצת gcloud init או gcloud auth login. כדי לבדוק איזה חשבון פעיל, אפשר להריץ את הפקודה gcloud auth list.

מריצים את הפקודה הבאה:

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred"; "x-goog-user-project" = "PROJECT_ID" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://dialogflow.googleapis.com/API_VERSION/projects/my-gcp-project/operations/OPERATION_ID" | Select-Object -Expand Content

אתם אמורים לקבל תגובת JSON שדומה לזו:

{
  "name": "projects/PROJECT_ID/operations/some-operation-name-OPERATION_ID",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.dialogflow.API_VERSION.SomeOperationType",
    "state": "DONE"
  },
  "done": true,
  ...
}

בסיום הפעולה, מוחזר ערך state של SUCCESSFUL.

הצגה וביטול של פעולות

בנוסף לקבלת פעולה ספציפית, אתם יכולים להציג רשימה של פעולות ולבטל אותן. אפשר לעיין ב-methods‏ list ו-cancel של הסוג Operations.

יכול להיות שהתוצאות של list יכללו פעולות שלא קשורות למשימה הנוכחית, אז חשוב לסנן את התוצאות.