Example query and response for the LogX Odin REST API /api/parse-query endpoint

parse-query-query.md

Example

How many TEUs of DoD Frozen Meat are heading to Hamburg?

Endpoint

GET request to /api/extract with URL encoded parameters text and pretty:

http://localhost:9000/api/parse-query?text=How%20many%20TEUs%20of%20DoD%20Frozen%20Meat%20are%20heading%20to%20Hamburg%3F

Using cURL

curl -X GET "http://localhost:9000/api/parse-query?text=How%20many%20TEUs%20of%20DoD%20Frozen%20Meat%20are%20heading%20to%20Hamburg%3F" -H  "accept: application/json"

parse-query-response.json

[
  {
    "need": {
      "text": "TEUs of DoD Frozen Meat",
      "subtype": "QuantifiedCargo",
      "labels": [
        "QuantifiedCargo",
        "Cargo",
        "Concept",
        "Entity"
      ],
      "arguments": [
        {
          "role": "unit",
          "text": "TEUs",
          "subtype": "Unit",
          "labels": [
            "Unit",
            "Measurement"
          ]
        },
        {
          "role": "concept",
          "text": "DoD Frozen Meat",
          "subtype": "Cargo",
          "labels": [
            "Cargo",
            "Concept",
            "Entity"
          ]
        }
      ]
    },
    "subtype": "CargoQuery",
    "labels": [
      "CargoQuery",
      "QuantityQuery",
      "Query"
    ],
    "constraints": [
      {
        "subtype": "DestinationConstraint",
        "labels": [
          "DestinationConstraint",
          "LocationConstraint",
          "Constraint"
        ],
        "text": "Hamburg"
      }
    ],
    "metadata": {
      "foundBy": "quantity-query-1",
      "id": "E:-822118745"
    }
  }
]