cloudmersive_image_api_client
Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
This Python package provides a native API client for Cloudmersive Image Recognition and Processing
- API version: v1
- Package version: 3.1.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import cloudmersive_image_api_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import cloudmersive_image_api_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import cloudmersive_image_api_client
from cloudmersive_image_api_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: Apikey
configuration = cloudmersive_image_api_client.Configuration()
configuration.api_key['Apikey'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['Apikey'] = 'Bearer'
# create an instance of the API class
api_instance = cloudmersive_image_api_client.AiImageDetectionApi(cloudmersive_image_api_client.ApiClient(configuration))
image_file = '/path/to/file.txt' # file | Image file to perform the operation on. Common file formats such as PNG, JPEG are supported.
try:
# Detect if an input image was generated using AI
api_response = api_instance.ai_image_detection_detect_file(image_file)
pprint(api_response)
except ApiException as e:
print("Exception when calling AiImageDetectionApi->ai_image_detection_detect_file: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://api.cloudmersive.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| AiImageDetectionApi | ai_image_detection_detect_file | POST /image/ai-detection/file | Detect if an input image was generated using AI |
| ArtisticApi | artistic_painting | POST /image/artistic/painting/{style} | Transform an image into an artistic painting automatically |
| ConvertApi | convert_to_bmp | POST /image/convert/to/bmp | Convert input image to Bitmap BMP format |
| ConvertApi | convert_to_gif | POST /image/convert/to/gif | Convert input image to GIF format |
| ConvertApi | convert_to_jpg | POST /image/convert/to/jpg/{quality} | Convert input image to JPG, JPEG format at specific quality |
| ConvertApi | convert_to_jpg_default_quality | POST /image/convert/to/jpg | Convert input image to JPG, JPEG format |
| ConvertApi | convert_to_photoshop | POST /image/convert/to/psd | Convert input image to Photoshop PSD format |
| ConvertApi | convert_to_png | POST /image/convert/to/png | Convert input image to PNG format |
| ConvertApi | convert_to_tiff | POST /image/convert/to/tiff | Convert input image to TIFF format |
| ConvertApi | convert_to_web_p | POST /image/convert/to/webp | Convert input image to WebP format |
| EditApi | edit_auto_orient | POST /image/edit/auto-orient/remove-exif | Normalizes image rotation and removes EXIF rotation data |
| EditApi | edit_composite_basic | POST /image/edit/composite/{location} | Composite two images together |
| EditApi | edit_composite_precise | POST /image/edit/composite/precise | Composite two images together precisely |
| EditApi | edit_contrast_adaptive | POST /image/edit/contrast/{gamma}/adaptive | Adaptively adjust the contrast of the image to be more appealing and easy to see |
| EditApi | edit_crop_circle | POST /image/edit/crop/circle/{left}/{top}/{radius} | Crop an image to an circular area |
| EditApi | edit_crop_rectangle | POST /image/edit/crop/rectangle/{left}/{top}/{width}/{height} | Crop an image to a rectangular area |
| EditApi | edit_draw_polygon | POST /image/edit/draw/polygon | Draw a polygon onto an image |
| EditApi | edit_draw_rectangle | POST /image/edit/draw/rectangle | Draw a rectangle onto an image |
| EditApi | edit_draw_text | POST /image/edit/draw/text | Draw text onto an image |
| EditApi | edit_drop_shadow | POST /image/edit/drop-shadow/{X}/{Y}/{sigma}/{opacity} | Add a customizeable drop shadow to an image |
| EditApi | edit_invert | POST /image/edit/invert | Invert, negate the colors in the image |
| EditApi | edit_remove_exif_data | POST /image/edit/remove-exif | Remove EXIF data from the image |
| EditApi | edit_remove_transparency | POST /image/edit/remove-transparency | Remove transparency from the image |
| EditApi | edit_rotate | POST /image/edit/rotate/{degrees}/angle | Rotate an image any number of degrees |
| FaceApi | face_compare | POST /image/face/compare-and-match | Compare and match faces |
| FaceApi | face_crop_first | POST /image/face/crop/first | Crop image to face with square crop |
| FaceApi | face_crop_first_round | POST /image/face/crop/first/round | Crop image to face with round crop |
| FaceApi | face_detect_age | POST /image/face/detect-age | Detect the age of people in an image |
| FaceApi | face_detect_gender | POST /image/face/detect-gender | Detect the gender of people in an image |
| FaceApi | face_locate | POST /image/face/locate | Detect and find faces in an image |
| FaceApi | face_locate_with_landmarks | POST /image/face/locate-with-landmarks | Detect and find faces and landmarks eyes and nose and mouth in image |
| FilterApi | filter_black_and_white | POST /image/filter/black-and-white | Convert image to black-and-white grayscale |
| FilterApi | filter_despeckle | POST /image/filter/despeckle | Despeckle to remove point noise from the image |
| FilterApi | filter_edge_detect | POST /image/filter/edge-detect/{radius} | Detect and highlight edges in an image |
| FilterApi | filter_emboss | POST /image/filter/emboss/{radius}/{sigma} | Emboss an image |
| FilterApi | filter_gaussian_blur | POST /image/filter/blur/guassian/{radius}/{sigma} | Perform a guassian blur on the input image |
| FilterApi | filter_motion_blur | POST /image/filter/blur/motion/{radius}/{sigma}/{angle} | Perform a motion blur on the input image |
| FilterApi | filter_posterize | POST /image/filter/posterize | Posterize the image by reducing distinct colors |
| FilterApi | filter_swirl | POST /image/filter/swirl | Swirl distort the image |
| InfoApi | info_get_dominant_color | POST /image/get-info/dominant-color | Returns the dominant colors of the image |
| InfoApi | info_get_metadata | POST /image/get-info/metadata | Returns the image metadata including EXIF and resolution |
| NsfwApi | nsfw_classify | POST /image/nsfw/classify | Not safe for work (NSFW) content classification for Images |
| NsfwApi | nsfw_classify_advanced | POST /image/nsfw/classify/advanced | Advanced content moderation and not safe for work (NSFW) content classification for Images |
| NsfwApi | nsfw_classify_document | POST /image/nsfw/classify/document | Not safe for work (NSFW) content classification for Documents |
| NsfwApi | nsfw_classify_video | POST /image/nsfw/classify/video | Not safe for work (NSFW) content classification for Video |
| RecognizeApi | recognize_describe | POST /image/recognize/describe | Describe an image in natural language |
| RecognizeApi | recognize_detect_and_unskew_document | POST /image/recognize/detect-document/unskew | Detect and unskew a photo of a document |
| RecognizeApi | recognize_detect_text_fine | POST /image/recognize/detect-text/fine | Detect fine text in a photo of a document |
| RecognizeApi | recognize_detect_text_large | POST /image/recognize/detect-text/large | Detect large text in a photo |
| RecognizeApi | recognize_detect_vehicle_license_plates | POST /image/recognize/detect-vehicle-license-plates | Detect vehicle license plates in an image |
| RecognizeApi | recognize_find_symbol | POST /image/recognize/find/symbol | Find the location of a symbol in an image |
| RecognizeApi | recognize_similarity_compare | POST /image/recognize/similarity/compare | Compare two images for similarity |
| RecognizeApi | recognize_similarity_hash | POST /image/recognize/similarity/hash | Generate a perceptual image hash |
| RecognizeApi | recognize_similarity_hash_distance | POST /image/recognize/similarity/hash/distance | Calculates the similarity between two perceptual image hashes |
| ResizeApi | resize_post | POST /image/resize/preserveAspectRatio/{maxWidth}/{maxHeight} | Resize an image while preserving aspect ratio |
| ResizeApi | resize_resize_ai_super_sampling | POST /image/resize/ai/target | Resize an image with AI super sampling |
| ResizeApi | resize_resize_simple | POST /image/resize/target/{width}/{height} | Resize an image |
| TextGenerationApi | text_generation_create_handwriting_png | POST /image/text/create/handwriting/png | Create an image of handwriting in PNG format |
Documentation For Models
- AgeDetectionResult
- ColorResult
- CreateHandwritingRequest
- DetectedLicensePlate
- DominantColorResult
- DrawPolygonInstance
- DrawPolygonRequest
- DrawRectangleInstance
- DrawRectangleRequest
- DrawTextInstance
- DrawTextRequest
- Face
- FaceCompareResponse
- FaceLocateResponse
- FaceLocateWithLandmarksResponse
- FaceMatch
- FacePoint
- FaceWithLandmarks
- FindSymbolResult
- FineTextDetectionResult
- FineTextItem
- ImageAiDetectionResult
- ImageDescriptionResponse
- ImageMetadata
- ImageMetadataExifValue
- ImageSimilarityComparisonResponse
- ImageSimilarityHashDistanceRequest
- ImageSimilarityHashDistanceResponse
- ImageSimilarityHashResponse
- NsfwAdvancedResult
- NsfwResult
- PersonWithAge
- PolygonPoint
- RecognitionOutcome
- TextDetectionResult
- TextItem
- VehicleLicensePlateDetectionResult
Documentation For Authorization
Apikey
- Type: API key
- API key parameter name: Apikey
- Location: HTTP header
Author
Release files for cloudmersive-image-api-client 3.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cloudmersive_image_api_client-3.1.0.tar.gz | 66.0 kB | Details |
Release files / cloudmersive_image_api_client-3.1.0.tar.gz
| Download URL | cloudmersive_image_api_client-3.1.0.tar.gz |
|---|---|
| Size | 66.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b68fa5f440a189f5307ddea47a0b2fad9a1d0ca526dfda294d61450095848d73
|
|
BLAKE2b-256 checksum How to use checksums |
6475125b7f2741e740eea458f6cee878c8fe8d1f6fcf46c5b35bcd1db7f3f783
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|