https://docs.icepack.ai/ivr/ Recent content in The Icepack Vehicle Router on API Documentation Hugo -- gohugo.io en Tue, 23 Jan 2024 00:00:00 +0000 https://docs.icepack.ai/ivr/dimension/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/dimension/ Overview Distance, time, capacity, mass, weight, volume are all examples of measurement dimensions. Dimensions are things we measure when creating a model which either participate in the objective function (distance) or represent constraints (time or capacity). Time and Distance are actually very similar as they are both a function of both the origin and destination. A capacity dimension (such as in the CVRP) is a function of a single node. So we can add an attribute to each task or location which corresponds to a quantity which should impact this dimension. https://docs.icepack.ai/ivr/window/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/window/ Overview A window defines a feasible interval on a dimension, with a start and an end. Windows are created in attributes which are in turn linked to a dimension and task or location. This allows us to specify what the feasible windows are on a particular dimension for an activity. Windows are added to the attributes of either a task, location or vehicle shift. Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Window The Window defines a constraint which restricts the feasible values that may occur on a dimension. https://docs.icepack.ai/ivr/geocode/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/geocode/ Overview The term geocode is used to describe a pair of coordinates. In general, we mostly handle routing requests which are on the face of planet earth so we’ve biased the terminology used here in that direction. We only support a handful of surface types at the moment. Road network Oblate spheroid (Haversine distance for routing) Planar (straight line) User-defined (by providing a complete matrix) We still use the term geocode to describe the point-pairs in these contexts, but don’t do the validity checks when the points aren’t marked as being on the face of planet earth. https://docs.icepack.ai/ivr/location/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/location/ Overview Locations are used to model where things happen. This is useful when there are multiple tasks which occur at the same location and there are concepts which need to be modelled at a location level. Typical examples of this are modelling the depot as a location, and having times for entering the depot (regardless of how many tasks are picked up or dropped off). Another example is to create location times which incentivises customer orders which are at the same location to be grouped together. https://docs.icepack.ai/ivr/task/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/task/ Overview Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Task The Task defines a single activity that should be performed in a schedule. The task is the most granular modelling level supported. Schema definition message Task { required string taskId = 1; required string locationId = 2; repeated Attribute attributes = 3; repeated TripConstraint tripConstraints = 4; optional TaskRelation predecessors = 5; // IVR8 only optional TaskRelation successors = 6; // IVR8 only } Fields taskId The unqiue identifier for this task. https://docs.icepack.ai/ivr/job/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/job/ Overview Jobs are used to link together tasks in a schedule. There are two typical use cases for jobs. The first is a situation where vehicles are being physically loaded with goods and the vehicle capacity is a constraint being considered, one would model both the pickup and dropoff tasks of a vehicle. In this situation, we would also implicitly be modelling the reloading of vehicles (in a typical VRP context). https://docs.icepack.ai/ivr/vehicle/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/vehicle/ Overview Vehicles are the active resources in a schedule. The goal of the optimiser is to find an allocation of tasks to vehicles, and a sequence within each vehicle of the tasks assigned to it, that minimises the total cost. Without vehicles, there can be no schedule. In the simplest case there may be a single vehicle. In a more complex case, there could be many vehicles, and our goal is to choose the most cost effective vehicles among them. https://docs.icepack.ai/ivr/vehicle-class/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/vehicle-class/ Overview The vehicle class describes the way in which a vehicle behaves with respect to the tasks, locations associated with those tasks, and the transits, or movements, between locations. Vehicle classes can describe general behaviour for a group of vehicles, or each vehicle may belong to its own class. In addition, a vehicle class may specify the transit rules or compartment set which should be inherited by vehicles assigned to this class. https://docs.icepack.ai/ivr/vehicle-cost-class/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/vehicle-cost-class/ Overview Vehicle Cost Classes are used to model how vehicles should be priced by the scheduler. This includes two primary components: a fixed cost for using a vehicle belonging to a specified class and a marginal cost related to the cumulative dimension quantities for a vehicle. The fixed cost of a vehicle is incurred if the vehicle performs any task other than the shift tasks on the vehicle. The cost per unit of dimension assigned to a vehicle is determined by the attributes assigned to a cost class. https://docs.icepack.ai/ivr/transit-set/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/transit-set/ Overview Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Transit Set Transit sets define a collection of movements between locations. Transit sets are typically included in a model through transit generators directly or through a data upload which is then, again, referenced through a transit generator. Schema definition message TransitSet { repeated TransitValue transits = 1; } Fields transits A list of transit values. A transit value defines a dimensional quantity between an origin and destination pair. https://docs.icepack.ai/ivr/transit-generator/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/transit-generator/ Overview Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Transit Generator A transit generator is a container to describe a way in which transits between locations should be generated for a given model. Schema definition message TransitGenerator { required string id = 1; optional string requestId = 2; optional TransitSet transitSet = 3; } Fields id The unique identifier to be used to define this transit generator object. Duplicate id’s in a model will result in an invalid payload. https://docs.icepack.ai/ivr/compartment/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/compartment/ Overview Compartment modelling is typically used when large vehicles may have their carrying capacity broken up into areas, or compartments. We are interested in modelling the constraints that exist over collections of compartments. There may also be constraints between tasks as to which compartments they may be assigned to or the maximum holding capacity of a single compartment. Typical use cases for compartments include modelling upper and lower “decks” in a vehicle (where some products may not be placed on the upper deck), fuel compartments in a trailer where certain products may only be assigned to certain areas (such as petrol, diesel or paraffin). https://docs.icepack.ai/ivr/compartment-set/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/compartment-set/ Overview A compartment set describes a collection of compartments which constitute the total packing space of a single vehicle. A compartment set definition may be reused across different vehicles or assigned to a vehicle class. Applicable models IVR8 ivr8-yni1c9k2swof Compartment Set Schema definition message CompartmentSet { required string id = 1; repeated string compartmentIds = 2; repeated GroupLimit groupLimits = 3; } Fields id A unique identifier for the compartment set. https://docs.icepack.ai/ivr/task-sequence/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/task-sequence/ Overview A task sequence provides a mechanism to specify a particular sequence of tasks on a vehicle. The sequence may be used either as a pure evaluation (to identify points of infeasibility in a model) or to provide a starting point to the solver (if the task sequence is feasible). The solve request should be set in the mode corresponding to the desired usage (ReOptimise or Evaluate). Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Task Sequence The task sequence defines a sequence of tasks to be performed by a particular vehicle. https://docs.icepack.ai/ivr/transit-rule/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/transit-rule/ Overview Transit rules provide a mechanism to model conditional rules which are linked to the cumulative value on a dimension at some point in the schedule. Typical examples of this are lunch breaks or fatigue rules for line haul modelling. Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Transit Rule Schema definition message TransitRule { required string id = 1; required string dimensionId = 2; optional bool useStandingState = 3 [default = true]; optional bool useTransitState = 4 [default = false]; required string ruleIdPrefix = 5; repeated Trigger triggers = 6; } Fields id The unique identifier for this transit rule. https://docs.icepack.ai/ivr/model/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/model/ Overview The model object pulls all the individually defined pieces together into a single representation which can then be solved. The model encapsulates all the information required by the solver and can be thought of as “an instance of the problem to be solved”. Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Model Schema definition message Model { required DimensionConfiguration dimensions = 1; repeated Location locations = 2; repeated Job jobs = 3; repeated Vehicle vehicles = 4; repeated VehicleClass vehicleClasses = 5; repeated VehicleCostClass vehicleCostClasses = 6; repeated TransitRule transitRules = 7; repeated TransitGenerator transitGenerators = 8; repeated TaskSequence taskSequence = 9; repeated Compartment compartments = 10; //IVR 8 only repeated CompartmentSet compartmentSets = 11; //IVR 8 only } Fields dimensions A Dimension Configuration for this model instance. https://docs.icepack.ai/ivr/solve-request/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/solve-request/ Overview The solve request houses the model and the action that should be performed on the model. Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Endpoint POST: https://api.icepack.ai/vehicle-router/solve/ Solve Request Schema definition message SolveRequest { optional Model model = 1; // either model or modelId should be specified optional string modelId = 2; // the model ID from a previously optimised // request (for use with evaluate solve type) repeated TaskSequence routes = 3; // for solveType = [Evaluate, ReOptimise]. https://docs.icepack.ai/ivr/solution-response/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/solution-response/ Overview The solution response is the granular feedback provided by the scheduling engine for a given solve request. This is considered the primary output from the engine. The solution response contains all the dimensional evaluation information for each vehicle, i.e. travel durations and distances between locations as well as the instantaneous dimensional information (such as vehicle capacity) at each task performed in the schedule. Applicable models IVR7 ivr7-kt461v8eoaif IVR8 ivr8-yni1c9k2swof Endpoint GET: https://api. https://docs.icepack.ai/ivr/ivrdata/ Thu, 13 Jun 2019 00:00:00 +0000 https://docs.icepack.ai/ivr/ivrdata/ This is considered advanced usage of the API. If you’re just starting out, this is probably not the right place to be :-/ Overview The IVR Data schema provides a simple way to upload data for types which are common across different models (such as transit sets) as well as data which are specific to certain solve requests. Applicable models IVRData ivrdata-o43e0dvs78zq IVR7 ivr7-kt461v8eoaif (indirect) IVR8 ivr8-yni1c9k2swof (indirect) Cached Transit Set The cached transit set allows the user to upload a transit set to the API.