lpr-tool
Retrieve license plate recognition events, manage saved vehicles and labels, and search or save license plates across your organization.
Instructions
This tool interacts with the Rhombus LPR system to retrieve information about license plate recognition events and registered license plates.
Vs events-tool (camera): events-tool with eventType camera returns that camera’s VOD footage seekpoints (many activity types on the timeline, including vehicle-related activity when present). lpr-tool is for the LPR product surface: plate events, saved vehicles, labels, and plate search APIs across the org—use it when the user needs registry, labeling, or org-wide LPR queries, not only “what showed up on this camera’s timeline.”
The system's cameras may have LPR enabled, and when it is enabled, it will detect "license plate recognition" events when it sees a license plate come into view. However, it is possible that the recognized license is only a partial match, so keep that in mind when using this tool. Users will be able to save license plates into the system, and then additionally label them with a name.
Regarding vehicle labels: Users in the Rhombus LPR system can assign labels to vehicles. When a vehicle (license plate) is assigned a label, and then later is recognized by a rhombus security camera, it will attach the label to the event and will be available on the events returned from (get-saved-vehicles).
You should use the location-tool if trying to pair vehicle events to a particular location. Never use location UUIDs in reports, use names.
As such, if the user is asking anything about a label or labels it would be best practice to first call get-vehicle-labels and then get-vehicle-events or get-vehicle-events.
This tool has 3 modes of operation, determined by the "requestType" parameter:
get-vehicle-events: Retrieves a list of vehicle events that have been detected by the system. Please keep in mind that this has the potential to return a lot of data. However, 7 days should be a reasonable time range to start from if the user is not specific.
get-saved-vehicles: Retrieves a list of saved vehicles that have been saved in the organization.
get-vehicle-labels: Retrieves a list of vehicle labels that have been saved in the organization.
Its very likely that "vehicle", "car", and "license plates" are used interchangeably. Please keep this in mind.
Output filtering (all tools):
includeFields(string[]): Dot-notation paths to keep in the response (e.g."vehicleEvents.vehicleLicensePlate"). Omit to return all fields.filterBy(array): Predicates to filter array items. Each entry:{field, op, value}where op is one of= != > >= < <= contains. All conditions are ANDed. Example:[{field:"vehicleLicensePlate", op:"=", value:"ABC123"}]WARNING: some tool responses exceed 400k characters — use these params to request only the data you need.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| requestType | Yes | Org LPR operation (vehicle events, saved vehicles, labels, plate search, save vehicle). Per-camera VOD timeline seekpoints use events-tool (eventType camera). | |
| vehicleEventsArgs | Yes | Only necessary for requestType 'get-vehicle-events' | |
| timeZone | Yes | The timezone for formatting timestamps which should come from the location of the device for the LPR event, or the user's timezone. This is necessary for the tool to produce accurate formatted timestamps. | |
| licensePlateQuery | Yes | License plate number to search. Required for 'search-license-plates'. | |
| vehicleName | Yes | Name for the vehicle. Required for 'save-vehicle'. | |
| vehicleLicensePlate | Yes | License plate for the vehicle. Required for 'save-vehicle'. | |
| vehicleDescription | Yes | Description for the vehicle. Optional for 'save-vehicle'. | |
| includeFields | Yes | Dot-notation field paths to include in the response (e.g. "vehicleEvents.vehicleLicensePlate"). Pass null to return all fields. WARNING: some responses can exceed 400k characters — use includeFields to request only the data you need. For high-volume tools this may be required to get a complete answer. | |
| filterBy | Yes | Filter array items in the response by field values. All conditions are ANDed. Example: [{field: "vehicleLicensePlate", op: "=", value: "ABC123"}, {field: "confidence", op: ">", value: 0.8}] Use alongside includeFields to get only the specific records and fields you need. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| vehicleEvents | No | A list of license plate events, as requested by the request typeget-vehicle-events | |
| vehicleLabels | No | A list of vehicle labels, as requested by the request typeget-vehicle-labels | |
| savedVehicles | No | A list of saved vehicles, as requested by the request typeget-saved-vehicles | |
| licensePlateSearchResults | No | License plate search results | |
| saveVehicleResult | No | Result of saving a vehicle | |
| error | No | An error message if the request failed. |