Connectors Reference
Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Transform an image into an artistic painting automatically |
|
|
Convert input image to Bitmap BMP format |
|
|
Convert input image to GIF format |
|
|
Convert input image to JPG, JPEG format |
|
|
Convert input image to PNG format |
|
|
Convert input image to Photoshop PSD format |
|
|
Convert input image to TIFF format |
|
|
Convert input image to WebP format |
|
|
Normalizes image rotation and removes EXIF rotation data |
|
|
Edit_CompositeBasic (string location, file baseImage, file layeredImage) |
Composite two images together |
|
Adaptively adjust the contrast of the image to be more appealing and easy to see |
|
|
Edit_CropRectangle (integer left, integer top, integer width, integer height, file imageFile) |
Crop an image to a rectangular area |
|
Draw a polygon onto an image |
|
|
Draw a rectangle onto an image |
|
|
Draw text onto an image |
|
|
Edit_DropShadow (integer X, integer Y, integer sigma, integer opacity, file imageFile) |
Add a customizeable drop shadow to an image |
|
Remove transparency from the image |
|
|
Rotate an image any number of degrees |
|
|
Compare and match faces |
|
|
Crop image to face with square crop |
|
|
Crop image to face with round crop |
|
|
Detect the age of people in an image |
|
|
Detect the gender of people in an image |
|
|
Detect and find faces in an image |
|
|
Detect and find faces and landmarks eyes and nose and mouth in image |
|
|
Convert image to black-and-white grayscale |
|
|
Filter_GaussianBlur (integer radius, integer sigma, file imageFile) |
Perform a guassian blur on the input image |
|
Filter_MotionBlur (integer radius, integer sigma, integer angle, file imageFile) |
Perform a motion blur on the input image |
|
Despeckle to remove point noise from the image |
|
|
Detect and highlight edges in an image |
|
|
Filter_Emboss (integer radius, integer sigma, file imageFile) |
Emboss an image |
|
Posterize the image by reducing distinct colors |
|
|
Swirl distort the image |
|
|
Returns the dominant colors of the image |
|
|
Returns the image metadata including EXIF and resolution |
|
|
Not safe for work NSFW racy content classification |
|
|
Describe an image in natural language |
|
|
Recognize_DetectAndUnskewDocument (file imageFile, [Optional]string PostProcessingEffect) |
Detect and unskew a photo of a document |
|
Detect objects including types and locations in an image |
|
|
Detect people including locations in an image |
|
|
Detect fine text in a photo of a document |
|
|
Detect large text in a photo |
|
|
Detect vehicle license plates in an image |
|
|
Find the location of a symbol in an image |
|
|
Resize_Post (integer maxWidth, integer maxHeight, file imageFile) |
Resize an image while preserving aspect ratio |
|
Resize_ResizeSimple (integer width, integer height, file imageFile) |
Resize an image |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Image file to perform the operation on. Common file formats such as P... |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Transform an image into an artistic painting automatically
Description: Uses machine learning to automatically transform an image into an artistic painting. Due to depth of AI processing, depending on image size this operation can take up to 20 seconds.
Syntax:
CloudmersiveImageProcessing.Artistic_Painting (string style, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
style |
string (The style of the painting to apply. To start, try "udnie" a painting ...) |
The style of the painting to apply. To start, try "udnie" a painting ... |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to Bitmap BMP format
Description: Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToBmp (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to GIF format
Description: Converts the input image into GIF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToGif (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to JPG, JPEG format
Description: Converts the input image into JPEG/JPG format. Customize encoding parameters. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToJpg (integer quality, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
quality |
integer(int32) (Set the JPEG quality level; lowest quality is 1 (highest compression),...) |
Set the JPEG quality level; lowest quality is 1 (highest compression),... |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to PNG format
Description: Converts the input image into PNG format. Transparency is preserved when present. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToPng (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to Photoshop PSD format
Description: Converts the input image into PSD format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToPhotoshop (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to TIFF format
Description: Converts the input image into TIFF format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToTiff (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Convert input image to WebP format
Description: Converts the input image into WebP format. Supported input file formats include AAI, ART, ARW, AVS, BPG, BMP, BMP2, BMP3, BRF, CALS, CGM, CIN, CMYK, CMYKA, CR2, CRW, CUR, CUT, DCM, DCR, DCX, DDS, DIB, DJVU, DNG, DOT, DPX, EMF, EPDF, EPI, EPS, EPS2, EPS3, EPSF, EPSI, EPT, EXR, FAX, FIG, FITS, FPX, GIF, GPLT, GRAY, HDR, HEIC, HPGL, HRZ, ICO, ISOBRL, ISBRL6, JBIG, JNG, JP2, JPT, J2C, J2K, JPEG/JPG, JXR, MAT, MONO, MNG, M2V, MRW, MTV, NEF, ORF, OTB, P7, PALM, PAM, PBM, PCD, PCDS, PCL, PCX, PDF, PEF, PES, PFA, PFB, PFM, PGM, PICON, PICT, PIX, PNG, PNG8, PNG00, PNG24, PNG32, PNG48, PNG64, PNM, PPM, PSB, PSD, PTIF, PWB, RAD, RAF, RGB, RGBA, RGF, RLA, RLE, SCT, SFW, SGI, SID, SUN, SVG, TGA, TIFF, TIM, UIL, VIFF, VICAR, VBMP, WDP, WEBP, WPG, X, XBM, XCF, XPM, XWD, X3F, YCbCr, YCbCrA, YUV.
Syntax:
CloudmersiveImageProcessing.Convert_ToWebP (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Normalizes image rotation and removes EXIF rotation data
Description: Automatically orients the input image based on EXIF information and then removes the EXIF information. EXIF is an additional set of information stored in some images taken with cell phone cameras based on the orientation of the camera. By normalizing rotation and removing EXIF data these images become much easier to process.
Syntax:
CloudmersiveImageProcessing.Edit_AutoOrient (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Composite two images together
Description: Composites two input images together; a layered image onto a base image. The first image you input is the base image. The second image (the layered image) will be composited on top of this base image. Supports PNG transparency. To control padding you can include transparent pixels at the border(s) of your layered images as appropriate.
Syntax:
CloudmersiveImageProcessing.Edit_CompositeBasic (string location, file baseImage, file layeredImage)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
location |
string (Location to composite the layered images; possible values are: "center...) |
Location to composite the layered images; possible values are: "center... |
True |
|
|
baseImage |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
|
|
layeredImage |
(Image to layer on top of the base image.) |
Image to layer on top of the base image. |
True |
Returns:
Type:string(binary)
Summary: Adaptively adjust the contrast of the image to be more appealing and easy to see
Description: Uses Gamma to adjust the contrast adaptively the way the human eye sees the world. Results significantly improve the viewability and visual appeal of the image.
Syntax:
CloudmersiveImageProcessing.Edit_ContrastAdaptive (number gamma, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
gamma |
number(double) (Gamma value to adjust the contrast in the image. Recommended value is...) |
Gamma value to adjust the contrast in the image. Recommended value is... |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Crop an image to a rectangular area
Description: Crop an image to a target rectangular area
Syntax:
CloudmersiveImageProcessing.Edit_CropRectangle (integer left, integer top, integer width, integer height, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
left |
integer(int32) (The left edge of the rectangular crop area in pixels (X).) |
The left edge of the rectangular crop area in pixels (X). |
True |
|
|
top |
integer(int32) (The top edge of the rectangular crop area in pixels (Y).) |
The top edge of the rectangular crop area in pixels (Y). |
True |
|
|
width |
integer(int32) (The width of the rectangular crop area in pixels.) |
The width of the rectangular crop area in pixels. |
True |
|
|
height |
integer(int32) (The height of the rectangular crop area in pixels.) |
The height of the rectangular crop area in pixels. |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Draw a polygon onto an image
Description: Draw one or more polygons, with customized visuals, onto an image
Syntax:
CloudmersiveImageProcessing.Edit_DrawPolygon (DrawPolygonRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to draw one or more polygons on a base image |
True |
Returns:
Type:string(binary)
Summary: Draw a rectangle onto an image
Description: Draw one or more rectangles, with customized visuals, onto an image
Syntax:
CloudmersiveImageProcessing.Edit_DrawRectangle (DrawRectangleRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to draw one or more rectangles on a base image |
True |
Returns:
Type:string(binary)
Summary: Draw text onto an image
Description: Draw one or more pieces of text, with customized visuals, onto an image
Syntax:
CloudmersiveImageProcessing.Edit_DrawText (DrawTextRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to draw one or more pieces of text onto an image |
True |
Returns:
Type:string(binary)
Summary: Add a customizeable drop shadow to an image
Description: Add a customizeable drop shadow to the image
Syntax:
CloudmersiveImageProcessing.Edit_DropShadow (integer X, integer Y, integer sigma, integer opacity, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
X |
integer(int32) (Horizontal (X) offset of the drop shadow) |
Horizontal (X) offset of the drop shadow |
True |
|
|
Y |
integer(int32) (Vertical (Y) offset of the drop shadow) |
Vertical (Y) offset of the drop shadow |
True |
|
|
sigma |
integer(int32) (Sigma (blur distance) of the drop shadow) |
Sigma (blur distance) of the drop shadow |
True |
|
|
opacity |
integer(int32) (Opacity of the drop shadow; 0 is 0% and 100 is 100%) |
Opacity of the drop shadow; 0 is 0% and 100 is 100% |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Remove transparency from the image
Description: Removes any active transparency in the image. Effectively renders the image at the same resolution, in the same file format, over a white background, thus removing transparency.
Syntax:
CloudmersiveImageProcessing.Edit_RemoveTransparency (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Rotate an image any number of degrees
Description: Rotates an image by an arbitrary number of degrees
Syntax:
CloudmersiveImageProcessing.Edit_Rotate (number degrees, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
degrees |
number(double) (Degrees to rotate the image; values range from 0.0 to 360.0.) |
Degrees to rotate the image; values range from 0.0 to 360.0. |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Compare and match faces
Description: Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.
Syntax:
CloudmersiveImageProcessing.Face_Compare (file inputImage, file matchFace)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputImage |
(Image file to perform the operation on; this image can contain one or ...) |
Image file to perform the operation on; this image can contain one or ... |
True |
|
|
matchFace |
(Image of a single face to compare and match against.) |
Image of a single face to compare and match against. |
True |
Returns:
Type:FaceCompareResponse
Description: Results of comparing/matching faces in an image
Summary: Crop image to face with square crop
Description: Crop an image to the face (rectangular crop). If there is more than one face present, choose the first one.
Syntax:
CloudmersiveImageProcessing.Face_CropFirst (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Crop image to face with round crop
Description: Crop an image to the face (circular/round crop). If there is more than one face present, choose the first one.
Syntax:
CloudmersiveImageProcessing.Face_CropFirstRound (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Detect the age of people in an image
Description: Identify the age, position, and size of human faces in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.
Syntax:
CloudmersiveImageProcessing.Face_DetectAge (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:AgeDetectionResult
Description: Result from classifying the Age of people in an image
Summary: Detect the gender of people in an image
Description: Identify the gender, position, and size of human faces in an image, along with a recognition confidence level. People in the image should be facing the camera.
Syntax:
CloudmersiveImageProcessing.Face_DetectGender (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Description: Result from classifying the Gender of people in an image
Summary: Detect and find faces in an image
Description: Locate the positions of all faces in an image
Syntax:
CloudmersiveImageProcessing.Face_Locate (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:FaceLocateResponse
Description: Results of locating faces in an image
Summary: Detect and find faces and landmarks eyes and nose and mouth in image
Description: Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
Syntax:
CloudmersiveImageProcessing.Face_LocateWithLandmarks (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:FaceLocateWithLandmarksResponse
Description: Results of locating faces in an image
Summary: Convert image to black-and-white grayscale
Description: Remove color from the image by converting to a grayscale, black-and-white image
Syntax:
CloudmersiveImageProcessing.Filter_BlackAndWhite (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Perform a guassian blur on the input image
Description: Perform a gaussian blur on the input image
Syntax:
CloudmersiveImageProcessing.Filter_GaussianBlur (integer radius, integer sigma, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
radius |
integer(int32) (Radius in pixels of the blur operation; a larger radius will produce a...) |
Radius in pixels of the blur operation; a larger radius will produce a... |
True |
|
|
sigma |
integer(int32) (Sigma, or variance, of the gaussian blur operation) |
Sigma, or variance, of the gaussian blur operation |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Perform a motion blur on the input image
Description: Perform a motion blur on the input image at a specific angle
Syntax:
CloudmersiveImageProcessing.Filter_MotionBlur (integer radius, integer sigma, integer angle, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
radius |
integer(int32) (Radius in pixels of the blur operation; a larger radius will produce a...) |
Radius in pixels of the blur operation; a larger radius will produce a... |
True |
|
|
sigma |
integer(int32) (Sigma, or variance, of the motion blur operation) |
Sigma, or variance, of the motion blur operation |
True |
|
|
angle |
integer(int32) (Angle of the motion blur in degrees) |
Angle of the motion blur in degrees |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Despeckle to remove point noise from the image
Description: Remove point noise / despeckle the input image
Syntax:
CloudmersiveImageProcessing.Filter_Despeckle (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Detect and highlight edges in an image
Description: Perform an edge detection operation on the input image
Syntax:
CloudmersiveImageProcessing.Filter_EdgeDetect (integer radius, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
radius |
integer(int32) (Radius in pixels of the edge detection operation; a larger radius will...) |
Radius in pixels of the edge detection operation; a larger radius will... |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Emboss an image
Description: Perform an emboss operation on the input image
Syntax:
CloudmersiveImageProcessing.Filter_Emboss (integer radius, integer sigma, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
radius |
integer(int32) (Radius in pixels of the emboss operation; a larger radius will produce...) |
Radius in pixels of the emboss operation; a larger radius will produce... |
True |
|
|
sigma |
integer(int32) (Sigma, or variance, of the emboss operation) |
Sigma, or variance, of the emboss operation |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Posterize the image by reducing distinct colors
Description: Reduce the unique number of colors in the image to the specified level
Syntax:
CloudmersiveImageProcessing.Filter_Posterize (integer levels, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
levels |
integer(int32) (Number of unique colors to retain in the output image) |
Number of unique colors to retain in the output image |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Swirl distort the image
Description: Swirl distort the image by the specified number of degrees
Syntax:
CloudmersiveImageProcessing.Filter_Swirl (integer degrees, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
degrees |
integer(int32) (Degrees of swirl) |
Degrees of swirl |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Returns the dominant colors of the image
Description: Uses advanced image processing to extract the top 5 dominant colors in the image, returned in the order of dominance with the most-dominant color first. These are the primary perceptual colors used in the image as perceived by a viewer.
Syntax:
CloudmersiveImageProcessing.Info_GetDominantColor (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:DominantColorResult
Description: Result of performing a get dominant color operation
Summary: Returns the image metadata including EXIF and resolution
Description: Returns the metadata information on the image, including file type, EXIF (if available), and resolution.
Syntax:
CloudmersiveImageProcessing.Info_GetMetadata (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:ImageMetadata
Description: Metadata from an image
Summary: Not safe for work NSFW racy content classification
Description: Classify an image into Not Safe For Work (NSFW)/Porn/Racy content and Safe Content.
Syntax:
CloudmersiveImageProcessing.Nsfw_Classify (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:NsfwResult
Description: Result of an NSFW classification
Summary: Describe an image in natural language
Description: Generate an English language text description of the image as a sentence.
Syntax:
CloudmersiveImageProcessing.Recognize_Describe (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Description: Result of recognizing an image
Summary: Detect and unskew a photo of a document
Description: Detect and unskew a photo of a document (e.g. taken on a cell phone) into a perfectly square image. Great for document scanning applications; once unskewed, this image is perfect for converting to PDF using the Convert API or optical character recognition using the OCR API.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectAndUnskewDocument (file imageFile, [Optional]string PostProcessingEffect)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
|
|
PostProcessingEffect |
string (Optional, post-processing effects to apply to the email, default is No...) |
Optional, post-processing effects to apply to the email, default is No... |
False |
Returns:
Type:string(byte)
Summary: Detect objects including types and locations in an image
Description: Identify the position, size and description of objects in an image, along with a recognition confidence level. Detects both human people and objects in an image.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectObjects (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Description: Result of detecting objects in an image
Summary: Detect people including locations in an image
Description: Identify the position, and size of human people in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectPeople (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Description: Result of detecting objects in an image
Summary: Detect fine text in a photo of a document
Description: Identify the position, and size of small/fine text within a photograph of a document. Identify the location of small text in a photo - such as words and other forms of high density text. Can be used on a scan of a document or a photograph (e.g. smartphone camera) of a document, page or receipt. For OCR purposes - please see our Deep Learning OCR APIs.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectTextFine (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Description: Result of an operation to detect text in a photo
Summary: Detect large text in a photo
Description: Identify the position, and size of large text within a photograph. Identify the location of large text in a photo - such as signs, titles, etc. and other forms of large, low-density text. Not suitable for high-density text (e.g. scans of documents, receipts, etc.) for OCR purposes - for OCR, please see our Deep Learning OCR APIs.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectTextLarge (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:TextDetectionResult
Description: Result of an operation to detect text in a photo
Summary: Detect vehicle license plates in an image
Description: Identify the position, and size, and content of vehicle license plates in an image. License plates should be within 15-20 degrees on-axis to the camera.
Syntax:
CloudmersiveImageProcessing.Recognize_DetectVehicleLicensePlates (file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:VehicleLicensePlateDetectionResult
Description: Result of detecting vehicle license plates in an image
Summary: Find the location of a symbol in an image
Description: Determine if an image contains a symbol, and if so, the location of that symbol in the image.
Syntax:
CloudmersiveImageProcessing.Recognize_FindSymbol (file inputImage, file targetImage)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputImage |
(Image file to search through for the target image.) |
Image file to search through for the target image. |
True |
|
|
targetImage |
(Image to find in the input image.) |
Image to find in the input image. |
True |
Returns:
Type:FindSymbolResult
Description: Result of a find symbol operation on an input image
Summary: Resize an image while preserving aspect ratio
Description: Resize an image to a maximum width and maximum height, while preserving the image's original aspect ratio
Syntax:
CloudmersiveImageProcessing.Resize_Post (integer maxWidth, integer maxHeight, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
maxWidth |
integer(int32) (Maximum width of the output image - final image will be as large as po...) |
Maximum width of the output image - final image will be as large as po... |
True |
|
|
maxHeight |
integer(int32) (Maximum height of the output image - final image will be as large as p...) |
Maximum height of the output image - final image will be as large as p... |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary: Resize an image
Description: Resize an image to a specific width and specific height
Syntax:
CloudmersiveImageProcessing.Resize_ResizeSimple (integer width, integer height, file imageFile)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
width |
integer(int32) (Width of the output image - final image will be exactly this width) |
Width of the output image - final image will be exactly this width |
True |
|
|
height |
integer(int32) (Height of the output image - final image will be exactly this height) |
Height of the output image - final image will be exactly this height |
True |
|
|
imageFile |
(Image file to perform the operation on. Common file formats such as P...) |
Image file to perform the operation on. Common file formats such as P... |
True |
Returns:
Type:string(binary)
Summary:
Description: Result from classifying the Age of people in an image
Properties:
|
Name |
Type |
Summary |
|
PeopleIdentified |
integer(int32)
|
Number of people identified in the image with an age |
|
PeopleWithAge |
array of (PersonWithAge)
|
People in the image annotated with age information |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Individual color
Properties:
|
Name |
Type |
Summary |
|
B |
integer(int32)
|
Blue (B) channel pixel value of this color |
|
G |
integer(int32)
|
Green (G) channel pixel value of this color |
|
R |
integer(int32)
|
Red (R) channel pixel value of this color |
Summary:
Description: License plate found in the image
Properties:
|
Name |
Type |
Summary |
|
Height |
integer(int32)
|
Height of the license plate's location in pixels |
|
LicensePlateRecognitionConfidenceLevel |
number(double)
|
Confidence score on a range of 0.0 - 1.0 of the accuracy of the detected license plate, with higher scores being better; values about 0.75 are high confidence |
|
LicensePlateText_BestMatch |
string
|
Text from the license plate, highest-confidence result |
|
LicensePlateText_RunnerUp |
string
|
Alternate text from the license plate, based on second-highest-confidence result |
|
LocationX |
integer(int32)
|
X location of the left edge of the license plate, starting from the left edge of the photo (X = 0) |
|
LocationY |
integer(int32)
|
Y location of the top edge of the license plate, starting from the top edge of the photo (Y = 0) |
|
Width |
integer(int32)
|
Width of the license plate's location in pixels |
Summary:
Description: Single object instance, and associated details, detected in an image
Properties:
|
Name |
Type |
Summary |
|
Height |
integer(int32)
|
Height, in pixels, of the object |
|
ObjectClassName |
string
|
Class of the object. Example values are "person", "car", "dining table", etc. |
|
Score |
number(double)
|
Confidence score of detected object; possible values are between 0.0 and 1.0; values closer to 1.0 are higher confidence |
|
Width |
integer(int32)
|
Width, in pixels, of the object |
|
X |
integer(int32)
|
X location, in pixels, of the left side location of the object, with the right side being X + Width |
|
Y |
integer(int32)
|
Y location, in pixels, of the top side location of the object, with the bottom side being Y + Height |
Summary:
Description: Result of performing a get dominant color operation
Properties:
|
Name |
Type |
Summary |
|
DominantColors |
array of (ColorResult)
|
Dominant colors in the image, in order where most dominant color is in the first index position (0), the second most-dominant color is in index position 1 and so on |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Polygon instance to draw on an image
Properties:
|
Name |
Type |
Summary |
|
BorderColor |
string
|
Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. |
|
BorderWidth |
number(double)
|
Width in pixels of the border. Pass in 0 to draw a polygon with no border |
|
FillColor |
string
|
Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the polygon. |
|
Points |
array of (PolygonPoint)
|
Points (vertices) which comprise the polygon; valid polygons must have at least 3 points |
Summary:
Description: Request to draw one or more polygons on a base image
Properties:
|
Name |
Type |
Summary |
|
BaseImageBytes |
string(byte)
|
Image to draw polygons on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL |
|
BaseImageUrl |
string
|
Image to draw polygons on, as an HTTP or HTTPS fully-qualified URL |
|
PolygonsToDraw |
array of (DrawPolygonInstance)
|
Polygons to draw on the image. Polygons are drawn in index order. |
Summary:
Description: Rectangle instance to draw on an image
Properties:
|
Name |
Type |
Summary |
|
BorderColor |
string
|
Border Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. |
|
BorderWidth |
number(double)
|
Width in pixels of the border. Pass in 0 to draw a rectangle with no border |
|
FillColor |
string
|
Fill Color to use - can be a hex value (with #) or HTML common color name. Transparent colors are supported. Leave blank to not fill the rectangle. |
|
Height |
number(double)
|
Height in pixels of the rectangle |
|
Width |
number(double)
|
Width in pixels of the rectangle |
|
X |
number(double)
|
Pixel location of the left edge of the rectangle location |
|
Y |
number(double)
|
Pixel location of the top edge of the rectangle location |
Summary:
Description: Request to draw one or more rectangles on a base image
Properties:
|
Name |
Type |
Summary |
|
BaseImageBytes |
string(byte)
|
Image to draw rectangles on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL |
|
BaseImageUrl |
string
|
Image to draw rectangles on, as an HTTP or HTTPS fully-qualified URL |
|
RectanglesToDraw |
array of (DrawRectangleInstance)
|
Rectangles to draw on the image. Rectangles are drawn in index order. |
Summary:
Description: Text instance to draw on an image
Properties:
|
Name |
Type |
Summary |
|
Color |
string
|
Color to use - can be a hex value (with #) or HTML common color name |
|
FontFamilyName |
string
|
Font Family to use. Leave blank to default to "Arial". |
|
FontSize |
number(double)
|
Font size to use. |
|
Height |
number(double)
|
Height in pixels of the text box to draw the text in; text will wrap inside this box |
|
Text |
string
|
Text string to draw |
|
Width |
number(double)
|
Width in pixels of the text box to draw the text in; text will wrap inside this box |
|
X |
number(double)
|
Pixel location of the left edge of the text location |
|
Y |
number(double)
|
Pixel location of the top edge of the text location |
Summary:
Description: Request to draw one or more pieces of text onto an image
Properties:
|
Name |
Type |
Summary |
|
BaseImageBytes |
string(byte)
|
Image to draw text on, in bytes. You can also use the BaseImageUrl instead to supply image input as a URL |
|
BaseImageUrl |
string
|
Image to draw text on, as an HTTP or HTTPS fully-qualified URL |
|
TextToDraw |
array of (DrawTextInstance)
|
One or more pieces of text to draw onto the image |
Summary:
Description: Location of one face in an image
Properties:
|
Name |
Type |
Summary |
|
BottomY |
integer(int32)
|
Y coordinate of the bottom side of the face |
|
LeftX |
integer(int32)
|
X coordinate of the left side of the face |
|
RightX |
integer(int32)
|
X coordinate of the right side of the face |
|
TopY |
integer(int32)
|
Y coordinate of the top side of the face |
Summary:
Description: Results of comparing/matching faces in an image
Properties:
|
Name |
Type |
Summary |
|
ErrorDetails |
string
|
Details of any errors that occurred |
|
FaceCount |
integer(int32)
|
Number of faces found in the image |
|
Faces |
array of (FaceMatch)
|
Array of faces found in the input image |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Results of locating faces in an image
Properties:
|
Name |
Type |
Summary |
|
ErrorDetails |
string
|
Details of any errors that occurred |
|
FaceCount |
integer(int32)
|
Number of faces found in the image |
|
Faces |
array of (Face)
|
Array of faces found in the image |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Results of locating faces in an image
Properties:
|
Name |
Type |
Summary |
|
ErrorDetails |
string
|
Details of any errors that occurred |
|
FaceCount |
integer(int32)
|
Number of faces found in the image |
|
Faces |
array of (FaceWithLandmarks)
|
Array of faces found in the image |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Location of one face in an image, along with match results
Properties:
|
Name |
Type |
Summary |
|
BottomY |
integer(int32)
|
Y coordinate of the bottom side of the face |
|
HighConfidenceMatch |
boolean
|
True if there is a high confidence match, false otherwise |
|
LeftX |
integer(int32)
|
X coordinate of the left side of the face |
|
MatchScore |
number(double)
|
Match score from 0.0 to 1.0 with higher scores indicating a greater match; scores above 0.7 indicate a match |
|
RightX |
integer(int32)
|
X coordinate of the right side of the face |
|
TopY |
integer(int32)
|
Y coordinate of the top side of the face |
Summary:
Description: Point location within a face
Properties:
|
Name |
Type |
Summary |
|
X |
integer(int32)
|
X location, where 0 is the left-most pixel |
|
Y |
integer(int32)
|
Y location, where 0 is the top-most pixel |
Summary:
Description: Location of one face in an image
Properties:
|
Name |
Type |
Summary |
|
BottomAndSidesOfFace |
array of (FacePoint)
|
Point locations of the bottom and sides of the face (cheeks and chin) |
|
BottomY |
integer(int32)
|
Y coordinate of the bottom side of the face |
|
LeftEye |
array of (FacePoint)
|
Point locations of the left eye (the eye closest to the left side of the picture) |
|
LeftEyebrow |
array of (FacePoint)
|
Point locations of the left eyebrow (the eyebrow cloesest to the left side of the picture) |
|
LeftX |
integer(int32)
|
X coordinate of the left side of the face |
|
LipsInnerOutline |
array of (FacePoint)
|
Point locations of the inner outline of the lips |
|
LipsOuterOutline |
array of (FacePoint)
|
Point locations of the outer outline of the lips |
|
NoseBottom |
array of (FacePoint)
|
Point locations of the bottom (nostrils) of the nose |
|
NoseBridge |
array of (FacePoint)
|
Point locations of the nose bridge (the vertical portion of the nose) |
|
RightEye |
array of (FacePoint)
|
Point locations of the right eye (the eye closest to the right side of the picture) |
|
RightEyebrow |
array of (FacePoint)
|
Point locations of the right eyebrow (the eyebrow cloesest to the right side of the picture) |
|
RightX |
integer(int32)
|
X coordinate of the right side of the face |
|
TopY |
integer(int32)
|
Y coordinate of the top side of the face |
Summary: Image file to perform the operation on. Common file formats such as P...
Description: Image file to perform the operation on. Common file formats such as P...
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Result of a find symbol operation on an input image
Properties:
|
Name |
Type |
Summary |
|
Height |
integer(int32)
|
Height of the found location in pixels |
|
MatchScore |
number(double)
|
Score between 0.0 and 1.0 that measures how closely the symbol matched; scores above 0.2 are good |
|
Successful |
boolean
|
True if successful, false otherwise |
|
Width |
integer(int32)
|
Width of the found location in pixels |
|
XLeft |
integer(int32)
|
X location of the left edge of the found location in pixels |
|
YTop |
integer(int32)
|
Y location of the top edge of the found location in pixels |
Summary:
Description: Result of an operation to detect text in a photo
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
TextItems |
array of (FineTextItem)
|
Text items found in the input image |
|
TextItemsCount |
integer(int32)
|
Count of text items found in the input image |
Summary:
Description: Individual instance of text occuring in an image; one piece of text
Properties:
|
Name |
Type |
Summary |
|
Angle |
number(double)
|
Rotation Angle in radians of the text |
|
BottomLeftX |
integer(int32)
|
X coordinate of the bottom/left text location; 0 represents the left edge of the input image |
|
BottomLeftY |
integer(int32)
|
Y coordinate of the bottom/left text location; 0 represents the top edge of the input image |
|
BottomRightX |
integer(int32)
|
X coordinate of the bottom/right text location; 0 represents the left edge of the input image |
|
BottomRightY |
integer(int32)
|
Y coordinate of the bottom/right text location; 0 represents the top edge of the input image |
|
Height |
integer(int32)
|
Height in pixels of the text |
|
TopLeftX |
integer(int32)
|
X coordinate of the top/left text location; 0 represents the left edge of the input image |
|
TopLeftY |
integer(int32)
|
Y coordinate of the top/left text location; 0 represents the top edge of the input image |
|
TopRightX |
integer(int32)
|
X coordinate of the top/right text location; 0 represents the left edge of the input image |
|
TopRightY |
integer(int32)
|
Y coordinate of the top/right text location; 0 represents the top edge of the input image |
|
Width |
integer(int32)
|
Width in pixels of the text |
Summary:
Description: Result from classifying the Gender of people in an image
Properties:
|
Name |
Type |
Summary |
|
PeopleIdentified |
integer(int32)
|
Number of people identified in the image with a gender |
|
PersonWithGender |
array of (PersonWithGender)
|
People in the image annotated with gender information |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Result of recognizing an image
Properties:
|
Name |
Type |
Summary |
|
BestOutcome |
|
Specific recognition outcome |
|
Highconfidence |
boolean
|
Is the resulting best outcome recognition a high confidence outcome? |
|
RunnerUpOutcome |
|
Specific recognition outcome |
|
Successful |
boolean
|
Was the image processed successfully? |
Summary:
Description: Metadata from an image
Properties:
|
Name |
Type |
Summary |
|
BitDepth |
integer(int32)
|
Bits per pixel |
|
ColorSpace |
string
|
Color space of the image |
|
ExifProfileName |
string
|
Name of the EXIF profile used |
|
ExifValues |
array of (ImageMetadataExifValue)
|
EXIF tags and values embedded in the image |
|
FileFormat |
string
|
File format of the image |
|
Height |
integer(int32)
|
Height of the image in pixels |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
Width |
integer(int32)
|
Width of the image in pixels |
Summary:
Description: EXIF tag and value
Properties:
|
Name |
Type |
Summary |
|
DataType |
string
|
Date type of the EXIF value |
|
DataValue |
string
|
Value, formatted as a string of the EXIF value |
|
Tag |
string
|
Tag name for the EXIF value |
Summary:
Description: Result of an NSFW classification
Properties:
|
Name |
Type |
Summary |
|
ClassificationOutcome |
string
|
Classification result into four categories: SafeContent_HighProbability, UnsafeContent_HighProbability, RacyContent, SafeContent_ModerateProbability |
|
Score |
number(double)
|
Score between 0.0 and 1.0. Scores of 0.0-0.2 represent high probability safe content, while scores 0.8-1.0 represent high probability unsafe content. Content between 0.2 and 0.8 is of increasing raciness. |
|
Successful |
boolean
|
True if the classification was successfully run, false otherwise |
Summary:
Description: Result of detecting objects in an image
Properties:
|
Name |
Type |
Summary |
|
ObjectCount |
integer(int32)
|
Number of objects detected in the scene |
|
Objects |
array of (DetectedObject)
|
Array of objects detected in the scene |
|
Successful |
boolean
|
Was the image processed successfully? |
Summary:
Description: A person identified in an image age classification operation
Properties:
|
Name |
Type |
Summary |
|
Age |
number(double)
|
|
|
AgeClass |
string
|
The person's age range classification result in years; possible values are "0-2", "4-6", "8-13", "15-20", "25-32", "38-43", "48-53", "60+" |
|
AgeClassificationConfidence |
number(double)
|
Confidence level of age classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results |
|
FaceLocation |
|
Location of one face in an image |
Summary:
Description: A person identified in an image gender classification operation
Properties:
|
Name |
Type |
Summary |
|
FaceLocation |
|
Location of one face in an image |
|
GenderClass |
string
|
The person's identified gender; possible values are "Male", "Female" and "Unknown" |
|
GenderClassificationConfidence |
number(double)
|
Confidence level of gender classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results |
Summary:
Description: One point in a polygon
Properties:
|
Name |
Type |
Summary |
|
X |
number(double)
|
X location in pixels of this point in the polygon |
|
Y |
number(double)
|
Y location in pixels of this point in the polygon |
Summary:
Description: Specific recognition outcome
Properties:
|
Name |
Type |
Summary |
|
ConfidenceScore |
number(double)
|
Scores closer to 1 are better than scores closer to 0 |
|
Description |
string
|
English language description of the image |
Summary:
Description: Result of an operation to detect text in a photo
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
TextItems |
array of (TextItem)
|
Text items found in the input image |
|
TextItemsCount |
integer(int32)
|
Count of text items found in the input image |
Summary:
Description: Individual instance of text occuring in an image; one piece of text
Properties:
|
Name |
Type |
Summary |
|
Height |
integer(int32)
|
Height in pixels of the text item |
|
LeftX |
integer(int32)
|
Left X coordinate of the text location; 0 represents the left edge of the input image |
|
TopY |
integer(int32)
|
Top Y coordinate of the text location; 0 represents the top edge of the input image |
|
Width |
integer(int32)
|
Width in pixels of the text item |
Summary:
Description: Result of detecting vehicle license plates in an image
Properties:
|
Name |
Type |
Summary |
|
DetectedLicensePlateCount |
integer(int32)
|
The number of license plates detected in the image |
|
DetectedLicensePlates |
array of (DetectedLicensePlate)
|
License plates found in the image |
|
Successful |
boolean
|
Was the image processed successfully? |