cloudinary / analysis
Use the Analyze API to analyze any external asset and return details based on the type of analysis requested. Currently supports the following analysis options: * [AI Vision - Tagging](https://cloudinary.com/documentation/cloudinary_ai_vision_addon#tagging_mode) * [AI Vision - Moderation](https
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- overtrue/phplint: ^9.0
- phpunit/phpunit: ^9.0
README
Use the Analyze API to analyze any external asset and return details based on the type of analysis requested.
Currently supports the following analysis options:
- AI Vision - Tagging
- AI Vision - Moderation
- AI Vision - General
- Google tagging
- Captioning
- Cld Fashion
- Coco
- Lvis
- Unidet
- Human Anatomy
- Cld Text
- Shop Classifier
Notes:
- The Analyze API is currently in development and is available as a Public Beta, which means we value your feedback, so please feel free to share any thoughts with us.
- The analysis options require an active subscription to the relevant add-on. Learn more about registering for add-ons.
The API supports both Basic Authentication using your Cloudinary API Key and API Secret (which can be found on the Dashboard page of your Cloudinary Console) or OAuth2 (Contact support for more information regarding OAuth).
For more information, please visit https://cloudinary.com/documentation/analyze_api_reference.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "require": { "cloudinary/analysis": "*" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/analysis/vendor/autoload.php');
Configuration
The API uses Basic Authentication over HTTPS.
You can find your product environment configuration credentials in the API Keys page of the Cloudinary Console Dashboard.
You can either pass configuration with each $apiInstance
initialization:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure OAuth2 access token for authorization: OAuth2 // $config = Cloudinary\Analysis\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); // Configure Cloudinary URL: basicAuth $config = Cloudinary\Analysis\Configuration::getDefaultConfiguration() ->setCloudinaryUrl('cloudinary://key:secret@cloud_name'); $apiInstance = new Cloudinary\Analysis\Api\AnalysisApi(null, $config);
Or set the environment variable globally.
For example, to set a temporary environment variable:
-
On Mac or Linux:
export CLOUDINARY_URL=cloudinary://key:secret@cloud_name
-
On Windows:
set CLOUDINARY_URL=cloudinary://key:secret@cloud_name
And then you can simply initialize $apiInstance
as follows:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Cloudinary\Analysis\Api\AnalysisApi();
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new Cloudinary\Analysis\Api\AnalysisApi(); $analyzeAIVisionGeneralRequest = new \Cloudinary\Analysis\Model\AnalyzeAIVisionGeneralRequest(); // \Cloudinary\Analysis\Model\AnalyzeAIVisionGeneralRequest | A JSON object containing request parameters try { $result = $apiInstance->analyzeAiVisionGeneral($analyzeAIVisionGeneralRequest); print_r($result); } catch (Exception $e) { echo 'Exception when calling AnalysisApi->analyzeAiVisionGeneral: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.cloudinary.com/v2/analysis/CLOUD_NAME/analyze, except if the operation defines another base path.
Models
- AIVisionGeneralAnalysisData
- AIVisionGeneralAnalysisDataResponsesInner
- AIVisionModerationAnalysisData
- AIVisionModerationAnalysisDataResponsesInner
- AIVisionTaggingAnalysisData
- AIVisionTaggingAnalysisDataTagsInner
- AnalysisPayload
- AnalysisType
- AnalyzeAIVisionGeneralRequest
- AnalyzeAIVisionGeneralResponse
- AnalyzeAIVisionGeneralResponseAllOfData
- AnalyzeAIVisionModerationRequest
- AnalyzeAIVisionModerationResponse
- AnalyzeAIVisionModerationResponseAllOfData
- AnalyzeAIVisionTaggingRequest
- AnalyzeAIVisionTaggingRequestAllOfTagDefinitions
- AnalyzeAIVisionTaggingResponse
- AnalyzeAIVisionTaggingResponseAllOfData
- AnalyzeCaptioningRequest
- AnalyzeCaptioningResponse
- AnalyzeCaptioningResponseAllOfData
- AnalyzeCldFashionRequest
- AnalyzeCldFashionResponse
- AnalyzeCldFashionResponseAllOfData
- AnalyzeCldTextRequest
- AnalyzeCldTextResponse
- AnalyzeCldTextResponseAllOfData
- AnalyzeCocoRequest
- AnalyzeCocoResponse
- AnalyzeCocoResponseAllOfData
- AnalyzeCustomRequest
- AnalyzeCustomResponse
- AnalyzeCustomResponseAllOfData
- AnalyzeGoogleTaggingRequest
- AnalyzeGoogleTaggingResponse
- AnalyzeGoogleTaggingResponseAllOfData
- AnalyzeHumanAnatomyRequest
- AnalyzeHumanAnatomyResponse
- AnalyzeHumanAnatomyResponseAllOfData
- AnalyzeLvisRequest
- AnalyzeLvisResponse
- AnalyzeLvisResponseAllOfData
- AnalyzeResponse
- AnalyzeShopClassifierRequest
- AnalyzeShopClassifierResponse
- AnalyzeShopClassifierResponseAllOfData
- AnalyzeUnidetRequest
- AnalyzeUnidetResponse
- AnalyzeUnidetResponseAllOfData
- AnalyzeUriRequest
- BaseAnalyzeRequest
- BaseAnalyzeResponse
- CaptioningAnalysisData
- CaptioningAnalysisDataData
- CldFashionAnalysisData
- CldTextAnalysisData
- CocoAnalysisData
- CustomAnalysisData
- ErrorResponse
- ErrorResponseError
- Feature
- GoogleTaggingAnalysisData
- GoogleTaggingAnalysisDataLabelAnnotations
- GoogleTaggingAnalysisDataLabelAnnotationsLabelsInner
- HumanAnatomyAnalysisData
- Limits
- LimitsUsage
- LvisAnalysisData
- ShopClassifierAnalysisData
- Source
- UnidetAnalysisData
Authorization
basicAuth
- Type: HTTP basic authentication
OAuth2
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
https://oauth.cloudinary.com/oauth2/auth
- Scopes:
- media_analysis: Analyze media
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This Analyze API (Beta) PHP package is automatically generated.
- Package version:
0.1.0
- API version:
0.1.0
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen