OptimizeToursResponse

תגובה לאחר פתרון בעיה באופטימיזציה של סיור, שמכילה את המסלולים שבהם כל רכב נוסע, את המשלוחים שנדחו ואת העלות הכוללת של הפתרון.

ייצוג ב-JSON
{
  "routes": [
    {
      object (ShipmentRoute)
    }
  ],
  "requestLabel": string,
  "skippedShipments": [
    {
      object (SkippedShipment)
    }
  ],
  "validationErrors": [
    {
      object (OptimizeToursValidationError)
    }
  ],
  "metrics": {
    object (Metrics)
  }
}
שדות
routes[]

object (ShipmentRoute)

מסלולים שחושבו לכל רכב. המסלול ה-i תואם לרכב ה-i במודל.

requestLabel

string

עותק של OptimizeToursRequest.label, אם צוינה תווית בבקשה.

skippedShipments[]

object (SkippedShipment)

רשימה של כל המשלוחים שנדחו.

validationErrors[]

object (OptimizeToursValidationError)

רשימה של כל שגיאות האימות שזיהינו באופן עצמאי. אפשר לעיין בהסבר לגבי 'שגיאות מרובות' לגבי ההודעה OptimizeToursValidationError. במקום שגיאות, הסטטוס הזה יכלול אזהרות במקרה ש-solvingMode הוא DEFAULT_SOLVE.

metrics

object (Metrics)

מדדי משך זמן, מרחק ושימוש של הפתרון הזה.

OptimizeToursValidationError

תיאור של שגיאה או אזהרה שנתקלו בהן במהלך אימות של OptimizeToursRequest.

ייצוג ב-JSON
{
  "code": integer,
  "displayName": string,
  "fields": [
    {
      object (FieldReference)
    }
  ],
  "errorMessage": string,
  "offendingValues": string
}
שדות
code

integer

שגיאת אימות מוגדרת על ידי הצמד (code, displayName) שתמיד נמצא.

השדות שמופיעים אחרי הקטע הזה מספקים הקשר נוסף לגבי השגיאה.

MULTIPLE ERRORS: כשיש כמה שגיאות, תהליך האימות מנסה להפיק כמה מהן. בדומה למה שמתרחש במהלך הידור, זהו תהליך לא מושלם. חלק משגיאות האימות יהיו 'קריטיות', כלומר הן יעצרו את כל תהליך האימות. זה המצב, בין היתר, בשגיאות מסוג displayName="UNSPECIFIED". שגיאות מסוימות עלולות לגרום לתהליך האימות לדלג על שגיאות אחרות.

יציבות: הערכים של code ו-displayName אמורים להיות יציבים מאוד. עם זאת, קודים ושמות תצוגה חדשים עשויים להופיע לאורך זמן, וכתוצאה מכך בקשה (לא חוקית) מסוימת עשויה להניב צמד (code, displayName) שונה כי השגיאה החדשה הסתירה את השגיאה הישנה. לדוגמה, 'שגיאות מרובות'.

displayName

string

השם המוצג של השגיאה.

fields[]

object (FieldReference)

הקשר של שגיאה יכול לכלול 0, 1 (בדרך כלל) או יותר שדות. לדוגמה, אפשר להפנות לכלי הרכב מס' 4 ולאיסוף הראשון של משלוח מס' 2 באופן הבא:

fields { name: "vehicles" index: 4}
fields { name: "shipments" index: 2 subField {name: "pickups" index: 0} }

עם זאת, חשוב לזכור שהעוצמה של fields לא אמורה להשתנות עבור קוד שגיאה נתון.

errorMessage

string

מחרוזת לתיאור השגיאה, שאנשים יכולים לקרוא. יש מיפוי אחד-לאחד בין code לבין errorMessage (כשהקוד שונה מ-'UNSPECIFIED').

יציבות: לא יציבה: הודעת השגיאה שמשויכת ל-code נתון עשויה להשתנות עם הזמן (בתקווה שהיא תתבהר). במקום זאת, יש להשתמש ב-displayName וב-code.

offendingValues

string

יכול להכיל את הערכים של השדות. האפשרות הזו לא תמיד זמינה. אין להסתמך עליו בשום אופן, וצריך להשתמש בו רק לניפוי באגים ידני של מודל.

FieldReference

הקשר של שגיאת האימות. הערך FieldReference תמיד מתייחס לשדה נתון בקובץ הזה, ופועל לפי אותו מבנה היררכי. לדוגמה, אפשר לציין את רכיב מס' 2 של startTimeWindows ברכב מס' 5 באמצעות:

name: "vehicles" index: 5 subField { name: "endTimeWindows" index: 2 }

עם זאת, אנחנו משמיטים ישויות ברמה העליונה כמו OptimizeToursRequest או ShipmentModel כדי למנוע עומס בהודעה.

ייצוג ב-JSON
{
  "name": string,
  "subField": {
    object (FieldReference)
  },

  // Union field index_or_key can be only one of the following:
  "index": integer,
  "key": string
  // End of list of possible types for union field index_or_key.
}
שדות
name

string

שם השדה, למשל "vehicles".

subField

object (FieldReference)

שדה משנה בתצוגת עץ רפלקטיבית, אם יש צורך.

שדה האיחוד index_or_key.

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

index

integer

האינדקס של השדה אם הוא חוזר.

key

string

מפתח אם השדה הוא מפה.

מדדים

מדדים כלליים, שמצטברים מכל המסלולים.

ייצוג ב-JSON
{
  "aggregatedRouteMetrics": {
    object (AggregatedMetrics)
  },
  "skippedMandatoryShipmentCount": integer,
  "usedVehicleCount": integer,
  "earliestVehicleStartTime": string,
  "latestVehicleEndTime": string,
  "costs": {
    string: number,
    ...
  },
  "totalCost": number
}
שדות
aggregatedRouteMetrics

object (AggregatedMetrics)

נתון נצבר מכל הנתיבים. כל מדד הוא הסכום (או הערך המקסימלי, עבור עומסי עבודה) של כל שדות ShipmentRoute.metrics באותו שם.

skippedMandatoryShipmentCount

integer

מספר המשלוחים החובה שקודם להם עברה 'דילוג'.

usedVehicleCount

integer

מספר כלי הרכב שבהם נעשה שימוש. הערה: אם מסלול של רכב ריק ו-Vehicle.used_if_route_is_empty הוא true, הרכב נחשב ל'בשימוש'.

earliestVehicleStartTime

string (Timestamp format)

שעת ההתחלה המוקדמת ביותר של רכב משומש, מחושבת כערך המינימלי של ShipmentRoute.vehicle_start_time בכל כלי הרכב המשומשים.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

latestVehicleEndTime

string (Timestamp format)

שעת הסיום האחרונה של רכב משומש, מחושבת כערך המקסימלי של ShipmentRoute.vehicle_end_time בכל הרכבים המשומשים.

חותמת זמן בפורמט UTC 'Zulu' של RFC3339, עם רזולוציה של ננו-שנייה ועד תשע ספרות עשרוניות. דוגמאות: "2014-10-02T15:01:23Z" ו-"2014-10-02T15:01:23.045123456Z".

costs

map (key: string, value: number)

עלות הפתרון, לפי פירוט של שדות הבקשה שקשורים לעלויות. המפתחות הם נתיבים של פרוטו, ביחס לקלט OptimizeToursRequest, למשל 'model.shipments.pickups.cost', והערכים הם העלות הכוללת שנוצרה על ידי שדה העלות התואם, שנצברה לאורך כל הפתרון. במילים אחרות, costs["model.shipments.pickups.cost"] הוא הסכום של כל עלויות האיסוף בפתרון. כל העלויות שמוגדרות במודל מדווחות כאן בפירוט, למעט עלויות שקשורות ל-TransitionAttributes שמדווחות רק באופן מצטבר החל מינואר 2022.

totalCost

number

העלות הכוללת של הפתרון. הסכום של כל הערכים במפת העלויות.