Interpretar a resposta

Desenvolvedores do Espaço Econômico Europeu (EEE)

A API Route Optimization retorna rotas para veículos na solicitação correspondente. As entregas são atribuídas a veículos ou podem ser ignoradas, dependendo das propriedades da solicitação.

Uma mensagem OptimizeToursResponse (REST, gRPC) tem duas propriedades principais de nível superior:

  • routes[] são os trajetos de cada veículo com as respectivas entregas atribuídas. Cada Route contém métricas que refletem propriedades desse trajeto individual.
  • metrics são métricas agregadas para toda a resposta, em todos os veículos e planos de rota. As métricas de nível superior contêm as mesmas propriedades das métricas por rota, com valores agregados em todas as rotas.

Algumas propriedades nem sempre são preenchidas, dependendo dos resultados da otimização:

  1. skippedShipments[] lista os envios que não são feitos por nenhum veículo. Um envio pode ser ignorado se não puder ser realizado dentro das restrições especificadas ou se o custo para realizar o envio exceder o custo da penalidade. Por exemplo, se a coleta ou entrega de uma remessa tiver um timeWindow muito curto, talvez não seja possível ou econômico para um veículo fazer a visita durante o período necessário.
  2. validationErrors[] especifica erros que invalidam ou impossibilitam a resolução da solicitação quando o solvingMode dela está definido como VALIDATE_ONLY. No modo DEFAULT_SOLVE normal, os erros de validação aparecem em uma mensagem de erro em vez do corpo da resposta. O modo de resolução VALIDATE_ONLY pode informar vários erros de uma só vez, o que é útil para depurar solicitações rapidamente.

Propriedades de rota

Cada entrada routes[] é uma mensagem ShipmentRoute (REST, gRPC). Cada ShipmentRoute representa a atribuição de rota para um veículo específico da solicitação. As propriedades importantes de ShipmentRoute relacionadas ao Vehicle correspondente incluem:

  • vehicleIndex é o índice baseado em zero do Vehicle na mensagem de solicitação correspondente. As respostas REST omitem essa propriedade quando o valor é zero.
  • vehicleStartTime é o horário em que o veículo precisa começar o trajeto.
  • vehicleEndTime é o horário previsto para o veículo concluir o trajeto.

Em uma resposta, routes vai aparecer assim:

{
  "routes": [
    {
      "vehicleStartTime": "2024-02-13T00:00:00Z",
      "vehicleEndTime": "2024-02-13T00:38:42Z",
      "visits": [
        ...
      ],
      "transitions": [
        ...
      ],
      "metrics": {
        ...
      },
      ...
    }
  ],
  ...
}

Cada ShipmentRoute inclui uma lista ordenada de visits que o veículo vai concluir. Cada Visit (REST, gRPC) representa um VisitRequest (REST, gRPC) da solicitação correspondente. As propriedades importantes de Visit incluem:

  • shipmentIndex é o índice com base em zero da remessa a que esta visita pertence na solicitação correspondente.
  • isPickup é verdadeiro quando uma visita é uma retirada e falso quando é uma entrega. As respostas REST omitem essa propriedade quando o valor é "false".
  • visitRequestIndex é o índice baseado em zero do VisitRequest de Shipment.pickups ou Shipment.deliveries na solicitação correspondente que o Visit representa. As respostas REST omitem essa propriedade quando o valor é zero.
  • startTime é o horário previsto para o início da visita.
  • O loadDemands mapeia o tipo de carga para a quantidade de carga exigida para concluir o Visit. Os valores de carga são negativos para visitas de entrega, representando a carga sendo removida do veículo.

Um exemplo de Visit:

{
  "routes": [
    {
      ...
      "visits": [
        {
          "isPickup": true,
          "startTime": "2024-02-13T00:00:00Z",
          "detour": "0s"
        },
        ...
      ],
    },
    ...
  ],
  ...
}

Cada ShipmentRoute inclui uma lista ordenada de transitions que representam viagens entre visits para um determinado veículo. As propriedades importantes da mensagem Transition (REST, gRPC) incluem:

  • startTime é o horário em que o veículo vai começar a fazer a transição.
  • travelDuration é a duração em que o veículo precisa viajar para concluir a transição.
  • travelDistanceMeters é a distância em metros que o veículo precisa percorrer para concluir a transição.
  • trafficInfoUnavailable indica se os dados de tráfego estão disponíveis para a transição.
  • waitDuration representa o tempo de inatividade que o veículo passa esperando antes de poder iniciar o próximo Visit. Isso pode acontecer devido ao start_time dos seguintes Visit.
  • totalDuration é a duração total da transição, incluindo tempos de viagem, espera, intervalo e atraso.
  • vehicleLoads mapeia o tipo de carga para a quantidade de carga transportada pelo veículo durante essa transição.

Um exemplo de Transition:

{
  "routes": [
    {
      ...
      "transitions": [
        ...
        {
          "travelDuration": "1171s",
          "travelDistanceMeters": 9004,
          "waitDuration": "0s",
          "totalDuration": "1171s",
          "startTime": "2024-02-13T00:00:00Z"
        },
        ...
      ],
      ...
    }
  ],
  ...
}

Para mais informações sobre a relação entre vists e transitions, consulte Otimização da ordem de paradas de coleta e entrega e a documentação de referência ShipmentRoute (REST, gRPC). Para mais informações sobre as propriedades routePolyline e routeToken de uma mensagem Transition, consulte Polilinhas de transição e tokens de rota.

Propriedades das métricas

A mensagem Metrics (REST, gRPC) resume toda a solução. Algumas propriedades importantes do Metrics incluem:

  • totalCost é o custo total incorrido na conclusão dos trajetos. Leia mais sobre custos em Parâmetros do modelo de custo.
  • usedVehicleCount é o número total de veículos usados na solução. Os veículos podem ter rotas vazias quando o otimizador determina que o uso deles é desnecessário.
  • skippedMandatoryShipmentCount é o número de envios obrigatórios que foram ignorados. Um envio obrigatório não especifica um penaltyCost que é incorridos se o envio for ignorado. Os envios obrigatórios ainda podem ser ignorados se a performance deles não for viável de acordo com as restrições especificadas. Leia mais sobre custos em Parâmetros do modelo de custo.

Outras métricas são informadas como mensagens AggregatedMetrics (REST, gRPC). O tipo de mensagem AggregatedMetrics é usado para a propriedade Metrics.aggregatedRouteMetrics e para a propriedade ShipmentRoute.metrics. A propriedade Metrics.aggregatedRouteMetrics contém métricas agregadas em todos os ShipmentRoutes no OptimizeToursResponse. Cada propriedade ShipmentRoute.metrics contém métricas para esse ShipmentRoute específico.

As propriedades importantes de AggregatedMetrics incluem:

  • performedShipmentCount é o número de entregas realizadas por veículos em todo o trajeto.
  • travelDuration é o tempo total que os veículos passam em trânsito enquanto concluem as rotas.
  • waitDuration é o tempo total que os veículos passam esperando enquanto completam os trajetos.
  • delayDuration é o tempo total de atraso dos veículos. Normalmente, esse valor é zero, a menos que TransitionAttributes sejam usados na solicitação.
  • breakDuration é o tempo total que os veículos passam em intervalos enquanto concluem os trajetos.
  • visitDuration é o tempo total que os veículos passam realizando visitas enquanto concluem as rotas. Essa é a soma de todos os valores de VisitRequest.duration para VisitRequests correspondentes a Visits atribuídos ao veículo aplicável.
  • totalDuration é a duração total necessária para concluir as rotas dos veículos.
  • travelDistanceMeters é a distância total percorrida pelos veículos ao concluir os trajetos.
  • maxLoads mapeia os tipos de carga para a quantidade máxima de carga transportada pelos veículos em qualquer ponto das rotas.

Exemplo de mensagem Metrics:

{
  "routes": [
    ...
  ],
  "metrics": {
    "aggregatedRouteMetrics": {
      "performedShipmentCount": 1,
      "travelDuration": "2322s",
      "waitDuration": "0s",
      "delayDuration": "0s",
      "breakDuration": "0s",
      "visitDuration": "0s",
      "totalDuration": "2322s",
      "travelDistanceMeters": 18603
    },
    "usedVehicleCount": 1,
    "earliestVehicleStartTime": "2024-02-13T00:00:00Z",
    "latestVehicleEndTime": "2024-02-13T00:38:42Z",
    "totalCost": 18.603,
    "costs": {
      "model.vehicles.cost_per_kilometer": 18.603
    }
  }
}

Exemplo completo

Um exemplo completo de resposta para a solicitação de Criar uma solicitação é assim:

{
  "routes": [
    {
      "vehicleStartTime": "2024-02-13T00:00:00Z",
      "vehicleEndTime": "2024-02-13T00:38:42Z",
      "visits": [
        {
          "isPickup": true,
          "startTime": "2024-02-13T00:00:00Z",
          "detour": "0s"
        },
        {
          "startTime": "2024-02-13T00:19:31Z",
          "detour": "0s"
        }
      ],
      "transitions": [
        {
          "travelDuration": "0s",
          "waitDuration": "0s",
          "totalDuration": "0s",
          "startTime": "2024-02-13T00:00:00Z"
        },
        {
          "travelDuration": "1171s",
          "travelDistanceMeters": 9004,
          "waitDuration": "0s",
          "totalDuration": "1171s",
          "startTime": "2024-02-13T00:00:00Z"
        },
        {
          "travelDuration": "1151s",
          "travelDistanceMeters": 9599,
          "waitDuration": "0s",
          "totalDuration": "1151s",
          "startTime": "2024-02-13T00:19:31Z"
        }
      ],
      "metrics": {
        "performedShipmentCount": 1,
        "travelDuration": "2322s",
        "waitDuration": "0s",
        "delayDuration": "0s",
        "breakDuration": "0s",
        "visitDuration": "0s",
        "totalDuration": "2322s",
        "travelDistanceMeters": 18603
      },
      "routeCosts": {
        "model.vehicles.cost_per_kilometer": 18.603
      },
      "routeTotalCost": 18.603
    }
  ],
  "metrics": {
    "aggregatedRouteMetrics": {
      "performedShipmentCount": 1,
      "travelDuration": "2322s",
      "waitDuration": "0s",
      "delayDuration": "0s",
      "breakDuration": "0s",
      "visitDuration": "0s",
      "totalDuration": "2322s",
      "travelDistanceMeters": 18603
    },
    "usedVehicleCount": 1,
    "earliestVehicleStartTime": "2024-02-13T00:00:00Z",
    "latestVehicleEndTime": "2024-02-13T00:38:42Z",
    "totalCost": 18.603,
    "costs": {
      "model.vehicles.cost_per_kilometer": 18.603
    }
  }
}