petsPictureQualityDetectForImage(params: Object)

Requires:
AIKit≥1.3.0@ray-js/ray≥1.7.20
Platforms:
iOSAndroid
import { ai } from '@ray-js/ray';

const { petsPictureQualityDetectForImage } = ai;

// Promise usage
try {
  const res = await petsPictureQualityDetectForImage({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

Description

Pet image quality detection

Parameters

PropertyTypeRequiredDefaultDescription
inputImagePathstringYes-Image input path
labelAllow1 | 2No1Recognition type enum
objectAreaPercentnumberYes-Ratio of the detected object size to the entire image; default 30, meaning: filter out if less than 30%
objectFaceRotationAnglenumberYes-Face rotation angle of the detected object; default 45, meaning: filter out if over 45%
objectFaceSideAnglenumberYes-Face profile angle of the detected object; default 40, meaning: filter out if over 40%
maximumPictureBrightnessnumberYes-Maximum brightness
minimumPictureBrightnessnumberYes-Minimum brightness
complete() => voidNo-Completion callback (executed on both success and failure)
success(params: Object) => voidNo-Callback on successful API call
fail(params: Object) => voidNo-Failure callback
success callback parameters
PropertyTypeDescription
imagePathstringImage URL
lowQualitybooleanWhether the image is low quality
lowQualityReasonnumberReason for low quality
fail callback parameters
PropertyTypeDescription
errorMsgstringError message
errorCodestring | numberError code
Error extension

Return Value

None

Valid Values

labelAllow
ValueDescriptionAIKit Since
1Catv1.7.0
2Dogv1.7.0

Examples

import { ai } from '@ray-js/ray'

ai.petsPictureQualityDetectForImage({
  inputImagePath: "xx",
  labelAllow: 1,
  objectAreaPercent: 1,
  objectFaceRotationAngle: 1,
  objectFaceSideAngle: 1,
  maximumPictureBrightness: 1,
  minimumPictureBrightness: 1,
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});