Download OpenAPI specification:Download
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
[- {
- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
]
Supported values for FaceDetectorResourceId
are:
none, cpu, gpu, accurate_cpu, accurate_gpu, cpu_remote, gpu_remote, any_remote, accurate_cpu_remote, accurate_gpu_remote, accurate_any_remote
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Supported values for PedestrianDetectorResourceId
are:
none, cpu_remote, gpu_remote, any_remote, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote
Supported values for SpoofDetectorResourceIds
are:
none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote
Supported values for PedestrianExtractorResourceId
are:
cpu, gpu, any, none
Supported values for ObjectDetectorResourceId
are:
none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote
Supported values for FaceSaveStrategy
are:
Balanced, All, MatchedOnly
Supported values for PedestrianSaveStrategy
are:
Balanced, All
Supported values for ObjectSaveStrategy
are:
Balanced, All
New camera configuration.
id required | string <uuid> |
name required | string |
source required | string |
enabled required | boolean |
required | object (VideoFaceDetectorConfig) |
object (VideoPedestrianDetectorConfig) | |
faceDetectorResourceId required | string |
templateGeneratorResourceId required | string |
pedestrianDetectorResourceId | string or null |
pedestrianExtractorResourceId | string or null |
redetectionTime required | integer <int32> |
templateGenerationTime required | integer <int32> |
trackMotionOptimization required | string |
trackSpeedAccuracyMode | string or null |
faceSaveStrategy required | string |
pedestrianSaveStrategy | string or null |
maskImagePath required | string or null |
saveFrameImageData required | boolean |
imageQuality required | integer <int32> |
mpeG1PreviewEnabled required | boolean |
mpeG1PreviewPort required | integer <int32> |
mpeG1VideoBitrate required | integer <int32> |
previewMaxDimension required | integer <int32> |
spoofDetectorResourceIds | Array of strings or null |
object (CameraSpoofDetectorConfigUpdateRequest) | |
object (PreviewAttributesConfigUpdateRequest) | |
objectDetectorResourceId | string or null |
objectSaveStrategy | string or null |
object (ObjectDetectorConfigUpdateRequest) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "spoofDetectorResourceIds": [
- "string"
], - "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectSaveStrategy": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
Supported values for FaceDetectorResourceId
are:
none, cpu, gpu, accurate_cpu, accurate_gpu, cpu_remote, gpu_remote, any_remote, accurate_cpu_remote, accurate_gpu_remote, accurate_any_remote
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Supported values for PedestrianDetectorResourceId
are:
none, cpu_remote, gpu_remote, any_remote, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote
Supported values for SpoofDetectorResourceIds
are:
none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote
Supported values for PedestrianExtractorResourceId
are:
cpu, gpu, any, none
Supported values for ObjectDetectorResourceId
are:
none, sfe_object_cpu_remote, sfe_object_gpu_remote, sfe_object_any_remote
Supported values for FaceSaveStrategy
are:
Balanced, All, MatchedOnly
Supported values for PedestrianSaveStrategy
are:
Balanced, All
Supported values for ObjectSaveStrategy
are:
Balanced, All
New camera configuration.
name required | string Default: "camera name" |
source required | string Default: "rtsp://user:password@cameraHostnameOrIp:554/Streaming/Channels/101" |
enabled | boolean or null Default: false |
object (FaceDetectorConfigCreateRequest) | |
faceDetectorResourceId | string or null Default: "cpu" |
object (PedestrianDetectorConfigCreateRequest) | |
pedestrianDetectorResourceId | string or null Default: "none" |
pedestrianExtractorResourceId | string or null Default: "none" |
templateGeneratorResourceId | string or null Default: "cpu" |
redetectionTime | integer or null <int32> Default: 500 |
templateGenerationTime | integer or null <int32> Default: 500 |
trackMotionOptimization | string or null Default: "track.motion_optimization.history_long.fast" |
trackSpeedAccuracyMode | string or null Default: "accurate" |
faceSaveStrategy | string or null Default: "FirstFace, BestFace" |
pedestrianSaveStrategy | string or null Default: "Best" |
maskImagePath | string or null Default: null |
saveFrameImageData | boolean or null Default: true |
imageQuality | integer or null <int32> Default: 90 |
mpeG1PreviewEnabled | boolean or null Default: true |
mpeG1PreviewPort | integer or null <int32> Default: null |
mpeG1VideoBitrate | integer or null <int32> Default: 450000 |
previewMaxDimension | integer or null <int32> Default: 640 |
serviceName | string or null Default: "" |
spoofDetectorResourceIds | Array of strings or null Default: ["none"] |
object (CameraSpoofDetectorConfigCreateRequest) | |
object (PreviewAttributesConfigCreateRequest) | |
objectDetectorResourceId | string or null Default: "none" |
objectSaveStrategy | string or null Default: "Best" |
object (ObjectDetectorConfigCreateRequest) |
{- "name": "camera name",
- "source": "rtsp://user:password@cameraHostnameOrIp:554/Streaming/Channels/101",
- "enabled": false,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "cpu",
- "pedestrianDetectorConfig": {
- "minPedestrianSize": 80,
- "maxPedestrianSize": 2000,
- "maxPedestrians": 20,
- "confidenceThreshold": 2500
}, - "pedestrianDetectorResourceId": "none",
- "pedestrianExtractorResourceId": "none",
- "templateGeneratorResourceId": "cpu",
- "redetectionTime": 500,
- "templateGenerationTime": 500,
- "trackMotionOptimization": "track.motion_optimization.history_long.fast",
- "trackSpeedAccuracyMode": "accurate",
- "faceSaveStrategy": "FirstFace, BestFace",
- "pedestrianSaveStrategy": "Best",
- "maskImagePath": null,
- "saveFrameImageData": true,
- "imageQuality": 90,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": null,
- "mpeG1VideoBitrate": 450000,
- "previewMaxDimension": 640,
- "serviceName": "",
- "spoofDetectorResourceIds": [
- "none"
], - "spoofDetectorConfig": {
- "externalScoreThreshold": 0,
- "distantLivenessScoreThreshold": 90,
- "nearbyLivenessScoreThreshold": 90,
- "distantLivenessConditions": "default",
- "nearbyLivenessConditions": "default"
}, - "previewAttributesConfig": {
- "textFontSize": 12,
- "order": false,
- "size": false,
- "quality": false,
- "yawAngle": false,
- "pitchAngle": false,
- "rollAngle": false,
- "watchlistMemberId": false,
- "watchlistMemberName": true,
- "watchlistName": false,
- "matchingScore": false,
- "age": true,
- "gender": true,
- "templateQuality": false,
- "faceMaskStatus": false,
- "faceMaskConfidence": false,
- "sharpness": false,
- "brightness": false,
- "tintedGlasses": false,
- "heavyFrame": false,
- "glassStatus": false
}, - "objectDetectorResourceId": "none",
- "objectSaveStrategy": "Best",
- "objectDetectorConfig": {
- "minObjectSize": 40,
- "maxObjectSize": 2000,
- "maxObjects": 20,
- "confidenceThreshold": 5000,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
Page number, page size and sorting order can be specified. You can also show total items count.
id required | string <uuid> Id of the camera. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "timeAppeared": "2019-08-24T14:15:22Z",
- "timeDisappeared": "2019-08-24T14:15:22Z",
- "timeAppearedRelativeMs": 0,
- "timeDisappearedRelativeMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Page number, page size and sorting order can be specified. You can also show total items count.
id required | string <uuid> Id of the camera. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "receivedAt": "2019-08-24T14:15:22Z",
- "positionInMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
id required | string <uuid> Id of the EdgeStream. |
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "name": "string",
- "enabled": true,
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 0,
- "minFaceSize": 0.1,
- "maxFaceSize": 0.1,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 0.1,
- "inputThreshold": 0.1,
- "stability": 0.1,
- "maxFramesLost": 0
}, - "crop": {
- "enable": true,
- "maxSize": 0.1,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": true,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 0.1
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 0,
- "allowEmptyMessages": true
}, - "fullFrame": {
- "imageWidth": 0,
- "imageHeight": 0,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}
}
[- {
- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "name": "string",
- "enabled": true,
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 0,
- "minFaceSize": 0.1,
- "maxFaceSize": 0.1,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 0.1,
- "inputThreshold": 0.1,
- "stability": 0.1,
- "maxFramesLost": 0
}, - "crop": {
- "enable": true,
- "maxSize": 0.1,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": true,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 0.1
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 0,
- "allowEmptyMessages": true
}, - "fullFrame": {
- "imageWidth": 0,
- "imageHeight": 0,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}
}
]
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Supported values for FaceSaveStrategy
are:
Balanced, All, MatchedOnly
Supported values for SpoofDetectorResourceIds
are:
none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote
New EdgeStream configuration.
enabled | boolean Default: false |
name required | string Default: "unspecified" |
clientId required | string |
saveFrameImageData | boolean Default: false |
templateGeneratorResourceId | string or null Default: "cpu" |
faceSaveStrategy | string or null Default: "FirstFace, BestFace" |
spoofDetectorResourceIds | Array of strings or null Default: ["none"] |
object (EdgeStreamSpoofDetectorConfigCreateRequest) | |
object (EdgeStreamSettingsCreateRequest) |
{- "enabled": false,
- "name": "unspecified",
- "clientId": "string",
- "saveFrameImageData": false,
- "templateGeneratorResourceId": "cpu",
- "faceSaveStrategy": "FirstFace, BestFace",
- "spoofDetectorResourceIds": [
- "none"
], - "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 90,
- "nearbyLivenessScoreThreshold": 90,
- "distantLivenessConditions": "default",
- "nearbyLivenessConditions": "default"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 10,
- "minFaceSize": 20,
- "maxFaceSize": 200,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 1500,
- "inputThreshold": 1000,
- "stability": 85,
- "maxFramesLost": 25
}, - "crop": {
- "enable": true,
- "maxSize": 50,
- "imageFormat": "Raw",
- "imageQuality": 90
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": false,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 40
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 250,
- "allowEmptyMessages": false
}, - "fullFrame": {
- "imageWidth": null,
- "imageHeight": null,
- "imageFormat": "Raw",
- "imageQuality": 90
}, - "license": {
- "data": null
}
}
}
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "name": "string",
- "enabled": true,
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 0,
- "minFaceSize": 0.1,
- "maxFaceSize": 0.1,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 0.1,
- "inputThreshold": 0.1,
- "stability": 0.1,
- "maxFramesLost": 0
}, - "crop": {
- "enable": true,
- "maxSize": 0.1,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": true,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 0.1
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 0,
- "allowEmptyMessages": true
}, - "fullFrame": {
- "imageWidth": 0,
- "imageHeight": 0,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}
}
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Supported values for FaceSaveStrategy
are:
Balanced, All, MatchedOnly
Supported values for SpoofDetectorResourceIds
are:
none, liveness_distant_cpu_remote, liveness_distant_gpu_remote, liveness_distant_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote, liveness_nearby_any_remote
New EdgeStream configuration.
id required | string <uuid> |
clientId required | string |
enabled required | boolean |
name required | string |
saveFrameImageData | boolean or null |
templateGeneratorResourceId required | string |
faceSaveStrategy required | string |
spoofDetectorResourceIds | Array of strings or null |
object (EdgeStreamSpoofDetectorConfigUpdateRequest) | |
object (EdgeStreamSettingsUpdateRequest) |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "enabled": true,
- "name": "string",
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorResourceIds": [
- "string"
], - "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 10,
- "minFaceSize": 20,
- "maxFaceSize": 200,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 1500,
- "inputThreshold": 1000,
- "stability": 85,
- "maxFramesLost": 25
}, - "crop": {
- "enable": true,
- "maxSize": 50,
- "imageFormat": "Raw",
- "imageQuality": 90
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": false,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 40
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 250,
- "allowEmptyMessages": false
}, - "fullFrame": {
- "imageWidth": null,
- "imageHeight": null,
- "imageFormat": "Raw",
- "imageQuality": 90
}, - "license": {
- "data": null
}
}
}
{- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "name": "string",
- "enabled": true,
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 0,
- "minFaceSize": 0.1,
- "maxFaceSize": 0.1,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 0.1,
- "inputThreshold": 0.1,
- "stability": 0.1,
- "maxFramesLost": 0
}, - "crop": {
- "enable": true,
- "maxSize": 0.1,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": true,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 0.1
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 0,
- "allowEmptyMessages": true
}, - "fullFrame": {
- "imageWidth": 0,
- "imageHeight": 0,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}
}
Supported values for watchlistSyncOption
are:
None, All, Selected
id required | string <uuid> |
Settings for watchlist synchronization
watchlistSyncOption required | string Default: "None" |
watchlistIds | Array of strings or null |
{- "watchlistSyncOption": "None",
- "watchlistIds": [
- "string"
]
}
{- "watchlistSyncOption": "string",
- "watchlistIds": [
- "string"
]
}
{- "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
- "quality": 0,
- "templateQuality": 0,
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "processedAt": "2019-08-24T14:15:22Z",
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "leftEyeX": 0.1,
- "leftEyeY": 0.1,
- "rightEyeX": 0.1,
- "rightEyeY": 0.1,
- "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
- "type": "Regular",
- "age": 0.1,
- "gender": 0.1,
- "faceMaskConfidence": 0.1,
- "noseTipConfidence": 0.1,
- "faceMaskStatus": "Unknown",
- "faceArea": 0.1,
- "size": 0.1,
- "faceOrder": 0,
- "facesOnFrameCount": 0,
- "faceAreaChange": 0.1,
- "yawAngle": 0.1,
- "pitchAngle": 0.1,
- "rollAngle": 0.1,
- "autolearnClusterType": "string",
- "sharpness": 0.1,
- "brightness": 0.1,
- "tintedGlasses": 0.1,
- "heavyFrame": 0.1,
- "glassStatus": 0.1,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Page number, page size and sorting order can be specified. You can also show total items count.
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
- "quality": 0,
- "templateQuality": 0,
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "processedAt": "2019-08-24T14:15:22Z",
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "leftEyeX": 0.1,
- "leftEyeY": 0.1,
- "rightEyeX": 0.1,
- "rightEyeY": 0.1,
- "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
- "type": "Regular",
- "age": 0.1,
- "gender": 0.1,
- "faceMaskConfidence": 0.1,
- "noseTipConfidence": 0.1,
- "faceMaskStatus": "Unknown",
- "faceArea": 0.1,
- "size": 0.1,
- "faceOrder": 0,
- "facesOnFrameCount": 0,
- "faceAreaChange": 0.1,
- "yawAngle": 0.1,
- "pitchAngle": 0.1,
- "rollAngle": 0.1,
- "autolearnClusterType": "string",
- "sharpness": 0.1,
- "brightness": 0.1,
- "tintedGlasses": 0.1,
- "heavyFrame": 0.1,
- "glassStatus": 0.1,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Supported values for FaceDetectorResourceId
are:
cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Request containing reference image to be searched.
required | object (ImageData) |
threshold | integer <int32> Default: 30 |
object (FaceSearchDetectorConfig) | |
faceDetectorResourceId | string Default: "cpu" |
templateGeneratorResourceId | string Default: "cpu" |
{- "image": {
- "data": ""
}, - "threshold": 30,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "cpu",
- "templateGeneratorResourceId": "cpu"
}
{- "searchSessionId": "818068ab-dd15-41d8-9a25-820e16c4e745"
}
Supported values for FaceDetectorResourceId
are:
cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
Supported values for SpoofDetectorResourceId
are:
liveness_distant_any_remote, liveness_distant_cpu_remote, liveness_distant_gpu_remote
liveness_nearby_any_remote, liveness_nearby_cpu_remote, liveness_nearby_gpu_remote
SpoofCheckConfig.KeepEvaluatingConditionsAfterFirstFail
is used
to evaluate all conditions supplied with Nearby/Distant LivenessConditions
.
When true
it can have slight performance impact, because all conditions are evaluated
Request containing reference image to be checked and configuration.
required | object (ImageData) |
object (FaceSearchDetectorConfig) | |
faceDetectorResourceId | string Default: "cpu" |
spoofDetectorResourceIds | Array of strings Default: ["liveness_distant_cpu_remote"] |
object (SpoofCheckConfig) |
{- "image": {
- "data": ""
}, - "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "cpu",
- "spoofDetectorResourceIds": [
- "liveness_distant_cpu_remote"
], - "spoofCheckConfig": {
- "distantLivenessScoreThreshold": 90,
- "nearbyLivenessScoreThreshold": 90,
- "distantLivenessConditions": "default",
- "nearbyLivenessConditions": "default",
- "keepEvaluatingConditionsAfterFirstFail": false
}
}
{- "performed": true,
- "passed": true,
- "distantLivenessSpoofCheck": {
- "performed": true,
- "passed": true,
- "score": 0.1,
- "notPerformedReasons": [
- {
- "reasonMessage": "string"
}
]
}, - "nearbyLivenessSpoofCheck": {
- "performed": true,
- "passed": true,
- "score": 0.1,
- "notPerformedReasons": [
- {
- "reasonMessage": "string"
}
]
}
}
Supported values for FaceDetectorResourceId
are:
cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Request containing images with faces to be compared
required | object (FaceProbe) |
required | object (FaceProbe) |
{- "probeImage": {
- "image": {
- "data": ""
}, - "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "cpu",
- "templateGeneratorResourceId": "cpu"
}, - "referenceImage": {
- "image": {
- "data": ""
}, - "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "cpu",
- "templateGeneratorResourceId": "cpu"
}
}
{- "confidence": 0.1,
- "probeFaceDetails": {
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "quality": 0,
- "leftEyeX": 0.1,
- "leftEyeY": 0.1,
- "rightEyeX": 0.1,
- "rightEyeY": 0.1,
- "age": 0.1,
- "gender": "Male",
- "faceSize": 0.1,
- "faceMaskConfidence": 0.1,
- "noseTipConfidence": 0.1,
- "faceMaskStatus": "Unknown",
- "sharpness": 0.1,
- "brightness": 0.1,
- "tintedGlasses": 0.1,
- "heavyFrame": 0.1,
- "glassStatus": 0.1,
- "pitchAngle": 0.1,
- "yawAngle": 0.1,
- "rollAngle": 0.1,
- "faceArea": 0.1,
- "templateQuality": 0,
- "faceOrder": 0
}, - "referenceFaceDetails": {
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "quality": 0,
- "leftEyeX": 0.1,
- "leftEyeY": 0.1,
- "rightEyeX": 0.1,
- "rightEyeY": 0.1,
- "age": 0.1,
- "gender": "Male",
- "faceSize": 0.1,
- "faceMaskConfidence": 0.1,
- "noseTipConfidence": 0.1,
- "faceMaskStatus": "Unknown",
- "sharpness": 0.1,
- "brightness": 0.1,
- "tintedGlasses": 0.1,
- "heavyFrame": 0.1,
- "glassStatus": 0.1,
- "pitchAngle": 0.1,
- "yawAngle": 0.1,
- "rollAngle": 0.1,
- "faceArea": 0.1,
- "templateQuality": 0,
- "faceOrder": 0
}
}
{- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "receivedAt": "2019-08-24T14:15:22Z",
- "positionInMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Page number, page size and sorting order can be specified. You can also show total items count.
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "receivedAt": "2019-08-24T14:15:22Z",
- "positionInMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Two optional parameters can be specified that allow the image to be resize to given values. More specifically, minSize will resize the smaller edge to minSize, maxSize will resize the larger edge to maxSize.
id required | string <uuid> Id of the image. |
minSize | integer <int32> Minimum size of the smaller edge. |
maxSize | integer <int32> Maximum size of the larger edge. |
id required | string <uuid> Id of the individual. |
{- "entranceTime": "2019-08-24T14:15:22Z",
- "exitTime": "2019-08-24T14:15:22Z",
- "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Page number, page size and sorting order can be specified. You can also show total items count.
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "entranceTime": "2019-08-24T14:15:22Z",
- "exitTime": "2019-08-24T14:15:22Z",
- "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Page number, page size and sorting order can be specified. You can also show total items count.
id required | string <uuid> Id of the individual. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "timeAppeared": "2019-08-24T14:15:22Z",
- "timeDisappeared": "2019-08-24T14:15:22Z",
- "timeAppearedRelativeMs": 0,
- "timeDisappearedRelativeMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Supported values for FaceDetectorResourceId
are:
cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
Supported values for TemplateGeneratorResourceId
are:
cpu, gpu, any
Request containing image, grouping id and resources.
required | object (ImageData) |
groupingId required | string <uuid> |
matchThreshold | integer <int32> |
object (FaceDetectorConfig) | |
faceDetectorResourceId | string |
templateGeneratorResourceId | string |
{- "image": {
- "data": ""
}, - "groupingId": "0623992d-dd3b-464d-ac71-6d3dae8b6747",
- "matchThreshold": 0,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string"
}
{- "results": [
- {
- "entranceTime": "2019-08-24T14:15:22Z",
- "exitTime": "2019-08-24T14:15:22Z",
- "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
]
}
Specified tracklets must be part of the previous individual.
Request containing tracklets and previous individual id.
trackletsIds required | Array of strings <uuid> non-empty [ items <uuid > ] |
previousIndividualId required | string <uuid> |
{- "trackletsIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
], - "previousIndividualId": "24934456-8c83-4d91-85e7-dad15bdbd3a0"
}
{- "individualId": "71e477fd-125d-45ef-9857-0e1cc3fa4b98"
}
Individuals are merged into a individual, whose id is the first id in the request array of individuals.
Request containing array of individuals to be merged.
individualIds required | Array of strings <uuid> >= 2 items [ items <uuid > ] |
{- "individualIds": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "individualId": "71e477fd-125d-45ef-9857-0e1cc3fa4b98"
}
groupingId required | string <uuid> Id of the live grouping. |
{- "config": {
- "enabled": true,
- "step": 0,
- "slidingWindow": 0,
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
Request containing live grouping properties
object (LiveGroupingConfigCreateRequest) | |
description | string or null |
{- "config": {
- "enabled": true,
- "step": 600,
- "slidingWindow": 3600,
- "threshold": 40
}, - "description": "string"
}
{- "config": {
- "enabled": true,
- "step": 0,
- "slidingWindow": 0,
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
required | object (LiveGroupingConfigUpdateRequest) |
id required | string <uuid> |
description required | string or null |
{- "config": {
- "enabled": true,
- "step": 600,
- "slidingWindow": 3600,
- "threshold": 40
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
{- "config": {
- "enabled": true,
- "step": 0,
- "slidingWindow": 0,
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
groupingId required | string <uuid> Id of the live grouping. |
{- "cameras": [
- {
- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
], - "edgeStreams": [
- {
- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "clientId": "string",
- "name": "string",
- "enabled": true,
- "saveFrameImageData": true,
- "templateGeneratorResourceId": "string",
- "faceSaveStrategy": "string",
- "spoofDetectorConfig": {
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "settings": {
- "faceDetection": {
- "enable": true,
- "maxDetections": 0,
- "minFaceSize": 0.1,
- "maxFaceSize": 0.1,
- "orderBy": "DetectionConfidence",
- "tracking": {
- "outputThreshold": 0.1,
- "inputThreshold": 0.1,
- "stability": 0.1,
- "maxFramesLost": 0
}, - "crop": {
- "enable": true,
- "maxSize": 0.1,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}, - "faceExtraction": {
- "enable": true
}, - "faceLivenessPassive": {
- "enable": true,
- "strategy": "OnEachExtractedFace",
- "conditions": [
- {
- "parameter": "string",
- "lowerThreshold": 0.1,
- "upperThreshold": 0.1
}
]
}, - "faceIdentification": {
- "enable": true,
- "threshold": 0.1
}, - "messaging": {
- "enable": true,
- "strategy": "OnNewAndInterval",
- "interval": 0,
- "allowEmptyMessages": true
}, - "fullFrame": {
- "imageWidth": 0,
- "imageHeight": 0,
- "imageFormat": "Raw",
- "imageQuality": 0.1
}
}
}
]
}
groupingId required | string <uuid> Id of the live grouping. |
[- {
- "spoofDetectorResourceIds": [
- "string"
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "pedestrianDetectorConfig": {
- "minPedestrianSize": 0.1,
- "maxPedestrianSize": 0.1,
- "maxPedestrians": 0,
- "confidenceThreshold": 0
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "pedestrianDetectorResourceId": "string",
- "pedestrianExtractorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "trackSpeedAccuracyMode": "string",
- "faceSaveStrategy": "string",
- "pedestrianSaveStrategy": "string",
- "objectSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "serviceName": "string",
- "spoofDetectorConfig": {
- "externalScoreThreshold": 0.1,
- "distantLivenessScoreThreshold": 0.1,
- "nearbyLivenessScoreThreshold": 0.1,
- "distantLivenessConditions": "string",
- "nearbyLivenessConditions": "string"
}, - "previewAttributesConfig": {
- "textFontSize": 0,
- "order": true,
- "size": true,
- "quality": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "watchlistMemberId": true,
- "watchlistMemberName": true,
- "watchlistName": true,
- "matchingScore": true,
- "age": true,
- "gender": true,
- "templateQuality": true,
- "faceMaskStatus": true,
- "faceMaskConfidence": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}, - "objectDetectorResourceId": "string",
- "objectDetectorConfig": {
- "minObjectSize": 0.1,
- "maxObjectSize": 0.1,
- "maxObjects": 0,
- "confidenceThreshold": 0,
- "objectTypesConfiguration": {
- "detectCar": false,
- "detectBus": false,
- "detectTruck": false,
- "detectMotorcycle": false,
- "detectBicycle": false,
- "detectBoat": false,
- "detectAirplane": false,
- "detectTrain": false,
- "detectBird": false,
- "detectCat": false,
- "detectDog": false,
- "detectHorse": false,
- "detectSheep": false,
- "detectCow": false,
- "detectBear": false,
- "detectElephant": false,
- "detectGiraffe": false,
- "detectZebra": false,
- "detectSuitcase": false,
- "detectBackpack": false,
- "detectHandbag": false,
- "detectUmbrella": false,
- "detectKnife": false
}
}
}
]
Page number, page size and sorting order can be specified. You can also show total items count.
groupingId required | string <uuid> Id of the live grouping. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "entranceTime": "2019-08-24T14:15:22Z",
- "exitTime": "2019-08-24T14:15:22Z",
- "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Page number, page size and sorting order can be specified. You can also show total items count.
groupingId required | string <uuid> Id of the live grouping. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "receivedAt": "2019-08-24T14:15:22Z",
- "positionInMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
groupingId required | string <uuid> Id of the live grouping. |
Request containing camera ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
groupingId required | string <uuid> Id of the live grouping |
Request containing camera ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
groupingId required | string <uuid> Id of the live grouping. |
Request containing camera ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
groupingId required | string <uuid> Id of the live grouping |
Request containing camera ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
id required | string <uuid> Id of the pedestrian. |
{- "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
- "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
- "streamId": "22cb260b-fac8-4ce4-8488-8f1949304300",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "processedAt": "2019-08-24T14:15:22Z",
- "quality": 0,
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "areaOnFrame": 0.1,
- "size": 0.1,
- "objectOrderOnFrameForType": 0,
- "objectsOnFrameCountForType": 0,
- "poses": [
- "string"
], - "earLeftX": 0.1,
- "earLeftY": 0.1,
- "earRightX": 0.1,
- "earRightY": 0.1,
- "eyeLeftX": 0.1,
- "eyeLeftY": 0.1,
- "eyeRightX": 0.1,
- "eyeRightY": 0.1,
- "noseX": 0.1,
- "noseY": 0.1,
- "neckX": 0.1,
- "neckY": 0.1,
- "shoulderLeftX": 0.1,
- "shoulderLeftY": 0.1,
- "shoulderRightX": 0.1,
- "shoulderRightY": 0.1,
- "elbowLeftX": 0.1,
- "elbowLeftY": 0.1,
- "elbowRightX": 0.1,
- "elbowRightY": 0.1,
- "wristLeftX": 0.1,
- "wristLeftY": 0.1,
- "wristRightX": 0.1,
- "wristRightY": 0.1,
- "hipLeftX": 0.1,
- "hipLeftY": 0.1,
- "hipRightX": 0.1,
- "hipRightY": 0.1,
- "kneeLeftX": 0.1,
- "kneeLeftY": 0.1,
- "kneeRightX": 0.1,
- "kneeRightY": 0.1,
- "ankleLeftX": 0.1,
- "ankleLeftY": 0.1,
- "ankleRightX": 0.1,
- "ankleRightY": 0.1,
- "objectAttributes": [
- {
- "type": "Hat",
- "floatValue": 0.1,
- "boolValue": true
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
Page number, page size and sorting order can be specified. You can also show total items count.
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "trackletId": "18b0bea4-b937-4751-a328-bee6bf88d141",
- "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
- "streamId": "22cb260b-fac8-4ce4-8488-8f1949304300",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "processedAt": "2019-08-24T14:15:22Z",
- "quality": 0,
- "cropLeftTopX": 0.1,
- "cropLeftTopY": 0.1,
- "cropRightTopX": 0.1,
- "cropRightTopY": 0.1,
- "cropLeftBottomX": 0.1,
- "cropLeftBottomY": 0.1,
- "cropRightBottomX": 0.1,
- "cropRightBottomY": 0.1,
- "areaOnFrame": 0.1,
- "size": 0.1,
- "objectOrderOnFrameForType": 0,
- "objectsOnFrameCountForType": 0,
- "poses": [
- "string"
], - "earLeftX": 0.1,
- "earLeftY": 0.1,
- "earRightX": 0.1,
- "earRightY": 0.1,
- "eyeLeftX": 0.1,
- "eyeLeftY": 0.1,
- "eyeRightX": 0.1,
- "eyeRightY": 0.1,
- "noseX": 0.1,
- "noseY": 0.1,
- "neckX": 0.1,
- "neckY": 0.1,
- "shoulderLeftX": 0.1,
- "shoulderLeftY": 0.1,
- "shoulderRightX": 0.1,
- "shoulderRightY": 0.1,
- "elbowLeftX": 0.1,
- "elbowLeftY": 0.1,
- "elbowRightX": 0.1,
- "elbowRightY": 0.1,
- "wristLeftX": 0.1,
- "wristLeftY": 0.1,
- "wristRightX": 0.1,
- "wristRightY": 0.1,
- "hipLeftX": 0.1,
- "hipLeftY": 0.1,
- "hipRightX": 0.1,
- "hipRightY": 0.1,
- "kneeLeftX": 0.1,
- "kneeLeftY": 0.1,
- "kneeRightX": 0.1,
- "kneeRightY": 0.1,
- "ankleLeftX": 0.1,
- "ankleLeftY": 0.1,
- "ankleRightX": 0.1,
- "ankleRightY": 0.1,
- "objectAttributes": [
- {
- "type": "Hat",
- "floatValue": 0.1,
- "boolValue": true
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Request containing new record grouping configuration.
object (RecordGroupingConfigCreateRequest) | |
description | string or null |
{- "config": {
- "threshold": 0
}, - "description": "string"
}
{- "config": {
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
New record grouping configuration.
required | object (RecordGroupingConfig) |
id required | string <uuid> |
description required | string or null |
{- "config": {
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
{- "config": {
- "threshold": 0
}, - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "description": "string"
}
groupingId required | string <uuid> Id of the record grouping. |
[- {
- "state": "Ready",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "source": "string",
- "recordedAt": "2019-08-24T14:15:22Z",
- "videoDurationMs": 0,
- "enabled": true,
- "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "string",
- "templateGeneratorResourceId": "string",
- "redetectionTime": 0,
- "templateGenerationTime": 0,
- "trackMotionOptimization": "string",
- "faceSaveStrategy": "string",
- "maskImagePath": "string",
- "saveFrameImageData": true,
- "imageQuality": 0,
- "mpeG1PreviewEnabled": true,
- "mpeG1PreviewPort": 0,
- "mpeG1VideoBitrate": 0,
- "previewMaxDimension": 0,
- "matchingConfig": {
- "matchDetectedFaces": true,
- "maxResultsCount": 0
}, - "description": "string",
- "processingStartTime": "2019-08-24T14:15:22Z",
- "processingDurationMs": 0
}
]
Page number, page size and sorting order can be specified. You can also show total items count.
groupingId required | string <uuid> Id of the record grouping. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "entranceTime": "2019-08-24T14:15:22Z",
- "exitTime": "2019-08-24T14:15:22Z",
- "bestFaceId": "e31e4289-5708-47d5-b6ca-d84960c86859",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Page number, page size and sorting order can be specified. You can also show total items count.
groupingId required | string <uuid> Id of the record grouping. |
Ascending | boolean |
PageNumber | integer <int32> [ 1 .. 2147483647 ] |
PageSize | integer <int32> [ 1 .. 2147483647 ] |
ShowTotalCount | boolean |
{- "totalItemsCount": 0,
- "items": [
- {
- "state": "New",
- "imageDataId": "b24530bd-cd48-48ab-ad8c-8f8a9678282e",
- "receivedAt": "2019-08-24T14:15:22Z",
- "positionInMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}
], - "pageSize": 0,
- "pageNumber": 0,
- "previousPage": "string",
- "nextPage": "string"
}
Supported values for FaceDetectorResourceId
are:
cpu, gpu, any, accurate_cpu, accurate_gpu, accurate_any
groupingId required | string <uuid> Id of the record grouping. |
Request containing image data.
required | object (ImageData) |
object (FaceDetectorConfig) | |
faceDetectorResourceId | string |
{- "imageData": {
- "data": ""
}, - "faceDetectorConfig": {
- "minFaceSize": 35,
- "maxFaceSize": 600,
- "maxFaces": 20,
- "confidenceThreshold": 450
}, - "faceDetectorResourceId": "string"
}
{- "frameId": "64f96310-c601-4761-a13a-8f7335bbd0b0",
- "frameImageDataId": "560155aa-cea0-4cc8-9a81-2a52f9f10c7f"
}
groupingId required | string <uuid> Id of the record grouping. |
Request containing video record ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
groupingId required | string <uuid> Id of the record grouping |
Request containing video records ids.
ids required | Array of strings <uuid> [ items <uuid > ] |
{- "ids": [
- "497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "property1": null,
- "property2": null
}
The new video data storage configuration.
storageMode required | string (VideoDataStorageMode) Enum: "None" "All" |
{- "storageMode": "None"
}
{- "storageMode": "None"
}
The new database cleanup configuration.
cleanupAmount | integer or null <int32> Deprecated |
enabled required | boolean |
maxFramesCount required | integer or null <int32> |
maxImageDataAge required | integer or null <int32> |
cleanupStart required | string or null <date-span> |
deleteSql required | boolean or null |
deleteMatchResults required | boolean or null |
{- "cleanupAmount": 0,
- "enabled": true,
- "maxFramesCount": 0,
- "maxImageDataAge": 0,
- "cleanupStart": "string",
- "deleteSql": true,
- "deleteMatchResults": true
}
{- "cleanupAmount": 0,
- "enabled": true,
- "maxFramesCount": 0,
- "maxImageDataAge": 0,
- "cleanupStart": "string",
- "deleteSql": true,
- "deleteMatchResults": true
}
{- "faceFeaturesConfig": {
- "age": true,
- "gender": true,
- "faceMask": true,
- "noseTip": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}
}
The new features configuration.
required | object (FeaturesConfigUpdateRequest) |
{- "faceFeaturesConfig": {
- "age": true,
- "gender": true,
- "faceMask": true,
- "noseTip": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}
}
{- "faceFeaturesConfig": {
- "age": true,
- "gender": true,
- "faceMask": true,
- "noseTip": true,
- "yawAngle": true,
- "pitchAngle": true,
- "rollAngle": true,
- "sharpness": true,
- "brightness": true,
- "tintedGlasses": true,
- "heavyFrame": true,
- "glassStatus": true
}
}
Default value for FaceBoundingBoxColor is #ecec5e
Default value for PedestrianBoundingBoxColor is #80b5ff
Default value for ObjectBoundingBoxColor is #e638d3
The new preview configuration.
faceBoundingBoxColor required | string |
pedestrianBoundingBoxColor required | string |
objectBoundingBoxColor | string or null |
{- "faceBoundingBoxColor": "string",
- "pedestrianBoundingBoxColor": "string",
- "objectBoundingBoxColor": "string"
}
{- "faceBoundingBoxColor": "string",
- "pedestrianBoundingBoxColor": "string",
- "objectBoundingBoxColor": "string"
}
The new search sessions cleanup configuration.
enabled required | boolean |
maxItemsCount required | integer or null <int32> |
maxSessionAge required | string or null <date-span> |
interval required | string or null <date-span> |
{- "enabled": true,
- "maxItemsCount": 0,
- "maxSessionAge": "string",
- "interval": "string"
}
{- "enabled": true,
- "maxItemsCount": 0,
- "maxSessionAge": "string",
- "interval": "string"
}
{- "enabled": true,
- "executionStartTime": "string",
- "maxAutoLearnFacesCount": 0,
- "selectionThreshold": 0,
- "maskedSelectionThreshold": 0,
- "noFaceMaskConfidenceThreshold": 0.1,
- "faceMaskConfidenceThreshold": 0.1
}
The new watchlist autolearn configuration.
enabled required | boolean |
executionStartTime required | string or null <date-span> |
maxAutoLearnFacesCount required | integer <int32> |
selectionThreshold required | integer <int32> |
maskedSelectionThreshold | integer <int32> |
noFaceMaskConfidenceThreshold | number <double> |
faceMaskConfidenceThreshold | number <double> |
{- "enabled": true,
- "executionStartTime": "string",
- "maxAutoLearnFacesCount": 0,
- "selectionThreshold": 0,
- "maskedSelectionThreshold": 0,
- "noFaceMaskConfidenceThreshold": 0.1,
- "faceMaskConfidenceThreshold": 0.1
}
{- "enabled": true,
- "executionStartTime": "string",
- "maxAutoLearnFacesCount": 0,
- "selectionThreshold": 0,
- "maskedSelectionThreshold": 0,
- "noFaceMaskConfidenceThreshold": 0.1,
- "faceMaskConfidenceThreshold": 0.1
}
id required | string <uuid> Id of the tracklet. |
{- "timeAppeared": "2019-08-24T14:15:22Z",
- "timeDisappeared": "2019-08-24T14:15:22Z",
- "timeAppearedRelativeMs": 0,
- "timeDisappearedRelativeMs": 0,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "createdAt": "2019-08-24T14:15:22Z",
- "updatedAt": "2019-08-24T14:15:22Z"
}