Socket
Socket
Sign inDemoInstall

cloudmersive-image-api-client

Package Overview
Dependencies
38
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    cloudmersive-image-api-client

Image_Recognition_and_Processing_APIs_let_you_use_Machine_Learning_to_recognize_and_process_images_and_also_perform_useful_image_modification_operations_


Version published
Weekly downloads
59
increased by210.53%
Maintainers
1
Install size
2.03 MB
Created
Weekly downloads
 

Readme

Source

cloudmersive-image-api-client

CloudmersiveImageApiClient - JavaScript client for cloudmersive-image-api-client Image Recognition and Processing APIs let you use Machine Learning to recognize and process images, and also perform useful image modification operations. Cloudmersive Image Recognition and Computer Vision API provides advanced computer vision and image recognition capabilities.

  • API version: v1
  • Package version: 1.2.6

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install cloudmersive-image-api-client --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your cloudmersive-image-api-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('cloudmersive-image-api-client') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var CloudmersiveImageApiClient = require('cloudmersive-image-api-client');

var defaultClient = CloudmersiveImageApiClient.ApiClient.instance;

// Configure API key authorization: Apikey
var Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix['Apikey'] = "Token"

var api = new CloudmersiveImageApiClient.ArtisticApi()

var style = "style_example"; // {String} The style of the painting to apply.  To start, try \"udnie\" a painting style.  Possible values are: \"udnie\", \"wave\", \"la_muse\", \"rain_princess\".

var imageFile = "/path/to/file.txt"; // {File} Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.artisticPainting(style, imageFile, callback);

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

ClassMethodHTTP requestDescription
CloudmersiveImageApiClient.ArtisticApiartisticPaintingPOST /image/artistic/painting/{style}Transform an image into an artistic painting automatically
CloudmersiveImageApiClient.EditApieditAutoOrientPOST /image/edit/auto-orient/remove-exifNormalizes image rotation and removes EXIF rotation data
CloudmersiveImageApiClient.EditApieditCompositeBasicPOST /image/edit/composite/{location}Composite two images together
CloudmersiveImageApiClient.EditApieditContrastAdaptivePOST /image/edit/contrast/{gamma}/adaptiveAdaptively adjust the contrast of the image to be more appealing and easy to see
CloudmersiveImageApiClient.EditApieditCropRectanglePOST /image/edit/crop/rectangle/{left}/{top}/{width}/{height}Crop an image to a rectangular area
CloudmersiveImageApiClient.EditApieditDrawPolygonPOST /image/edit/draw/polygonDraw a polygon onto an image
CloudmersiveImageApiClient.EditApieditDrawRectanglePOST /image/edit/draw/rectangleDraw a rectangle onto an image
CloudmersiveImageApiClient.EditApieditDrawTextPOST /image/edit/draw/textDraw text onto an image
CloudmersiveImageApiClient.EditApieditDropShadowPOST /image/edit/drop-shadow/{X}/{Y}/{sigma}/{opacity}Add a customizeable drop shadow to an image
CloudmersiveImageApiClient.EditApieditRotatePOST /image/edit/rotate/{degrees}/angleRotate an image any number of degrees
CloudmersiveImageApiClient.FaceApifaceComparePOST /image/face/compare-and-matchCompare and match faces
CloudmersiveImageApiClient.FaceApifaceCropFirstPOST /image/face/crop/firstCrop image to face (square)
CloudmersiveImageApiClient.FaceApifaceCropFirstRoundPOST /image/face/crop/first/roundCrop image to face (round)
CloudmersiveImageApiClient.FaceApifaceDetectAgePOST /image/face/detect-ageDetect the age of people in an image
CloudmersiveImageApiClient.FaceApifaceDetectGenderPOST /image/face/detect-genderDetect the gender of people in an image
CloudmersiveImageApiClient.FaceApifaceLocatePOST /image/face/locateFind faces in an image
CloudmersiveImageApiClient.FaceApifaceLocateWithLandmarksPOST /image/face/locate-with-landmarksFind faces and face landmarks (eyes, eye brows, nose, mouth) in an image
CloudmersiveImageApiClient.FilterApifilterBlackAndWhitePOST /image/filter/black-and-whiteConvert image to black-and-white grayscale
CloudmersiveImageApiClient.FilterApifilterDespecklePOST /image/filter/despeckleDespeckle (remove point noise) from the image
CloudmersiveImageApiClient.FilterApifilterEdgeDetectPOST /image/filter/edge-detect/{radius}Detect and highlight edges in an image
CloudmersiveImageApiClient.FilterApifilterEmbossPOST /image/filter/emboss/{radius}/{sigma}Emboss an image
CloudmersiveImageApiClient.FilterApifilterGaussianBlurPOST /image/filter/blur/guassian/{radius}/{sigma}Perform a guassian blur on the input image
CloudmersiveImageApiClient.FilterApifilterMotionBlurPOST /image/filter/blur/motion/{radius}/{sigma}/{angle}Perform a motion blur on the input image
CloudmersiveImageApiClient.FilterApifilterPosterizePOST /image/filter/posterizePosterize the image by reducing distinct colors
CloudmersiveImageApiClient.FilterApifilterSwirlPOST /image/filter/swirlSwirl distort the image
CloudmersiveImageApiClient.InfoApiinfoGetDominantColorPOST /image/get-info/dominant-colorReturns the dominant colors of the image
CloudmersiveImageApiClient.NsfwApinsfwClassifyPOST /image/nsfw/classifyNot safe for work (NSFW) racy content classification
CloudmersiveImageApiClient.RecognizeApirecognizeDescribePOST /image/recognize/describeDescribe an image in natural language
CloudmersiveImageApiClient.RecognizeApirecognizeDetectAndUnskewDocumentPOST /image/recognize/detect-document/unskewDetect and unskew a photo of a document
CloudmersiveImageApiClient.RecognizeApirecognizeDetectObjectsPOST /image/recognize/detect-objectsDetect objects, including types and locations, in an image
CloudmersiveImageApiClient.RecognizeApirecognizeDetectPeoplePOST /image/recognize/detect-peopleDetect people, including locations, in an image
CloudmersiveImageApiClient.RecognizeApirecognizeDetectTextFinePOST /image/recognize/detect-text/fineDetect fine text in a photo of a document
CloudmersiveImageApiClient.RecognizeApirecognizeDetectTextLargePOST /image/recognize/detect-text/largeDetect large text in a photo
CloudmersiveImageApiClient.RecognizeApirecognizeDetectVehicleLicensePlatesPOST /image/recognize/detect-vehicle-license-platesDetect vehicle license plates in an image
CloudmersiveImageApiClient.RecognizeApirecognizeFindSymbolPOST /image/recognize/find/symbolFind the location of a symbol in an image
CloudmersiveImageApiClient.ResizeApiresizePostPOST /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight}Resize an image while preserving aspect ratio
CloudmersiveImageApiClient.ResizeApiresizeResizeSimplePOST /image/resize/target/{width}/{height}Resize an image

Documentation for Models

Documentation for Authorization

Apikey

  • Type: API key
  • API key parameter name: Apikey
  • Location: HTTP header

FAQs

Last updated on 24 Nov 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc