Documentation for metadata.json

Documentation for `metadata.json`

Overview

The metadata.json file is a flexible JSON structure that clients can utilize to send additional metadata alongside the video file. This metadata enhances the context of the video data and supports more tailored processing and analysis. All fields are optional.

Example of `metadata.json`

Below is an example of how the metadata.json file might be structured:

{
  "site_id": 134188,
  "camera_id": "VI08",
  "client_id": 134188,
  "no_trans": "20818",
  "parc_origine": "RO",
  "date_recep": "16-jan-2019 10:09:57",
  "code_msg": "VI08",
  "date_start_analyse": "2020-01-16 10:09:57.216"
}

Field Descriptions

The fields within metadata.json serve specific purposes, and while all are optional, site_id and camera_id are highly recommended for submission. Here’s a brief overview of each:

Field	Type	Description
`site_id`	string	int
`camera_id`	string	int
`client_id`	string	int
`no_trans`	string	A unique transaction or identifier number. Optional.
`parc_origine`	string	Origin code or identifier, optional and specific to the client's needs.
`date_recep`	string	The reception date of the video file, optional. Should follow ISO 8601 or RFC 3339 time formats.
`code_msg`	string	A code related to the message or video, optional.
`date_start_analyse`	string	The start date of the analysis, optional and should be in ISO 8601 or RFC 3339 format.

Usage Notes

While all fields are optional, providing site_id and camera_id enhances data identification and processing.
The metadata.json is designed to be flexible, allowing clients to include additional fields specific to their needs.
The entire metadata will be included as part of the classification result JSON, ensuring that clients receive a comprehensive overview of the analysis context.

Formatting Guidelines

Dates should adhere to ISO 8601 or RFC 3339 formats for consistency and accuracy.
Clients are encouraged to use consistent field naming and data types to streamline processing and analysis.

This documentation outlines the structure and intent behind the metadata.json file, ensuring clients can effectively utilize this feature to augment their video data submissions.