Download the PHP package cloudinary/analysis without Composer
On this page you can find all versions of the php package cloudinary/analysis. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download cloudinary/analysis
More information about cloudinary/analysis
Files in cloudinary/analysis
Package analysis
Short Description 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://cloudinary.com/documentation/cloudinary_ai_vision_addon#moderation_mode) * [AI Vision - General](https://cloudinary.com/documentation/cloudinary_ai_vision_addon#general_mode) * [Google tagging](https://cloudinary.com/documentation/google_auto_tagging_addon) * [Captioning](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#ai_based_image_captioning) * [Cld Fashion](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Coco](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Lvis](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Unidet](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Human Anatomy](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Cld Text](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) * [Shop Classifier](https://cloudinary.com/documentation/cloudinary_ai_content_analysis_addon#supported_content_aware_detection_models) **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](https://support.cloudinary.com/hc/en-us/requests/new). * The analysis options require an active subscription to the relevant add-on. Learn more about [registering for add-ons](https://cloudinary.com/documentation/cloudinary_add_ons#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](https://console.cloudinary.com/pm)) or OAuth2 ([Contact support](https://support.cloudinary.com/hc/en-us/requests/new) for more information regarding OAuth).
License MIT
Homepage https://cloudinary.com/documentation/analyze_api_reference
Informations about the package analysis
Analyze API (Beta) PHP SDK
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
-
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
:
Then run composer install
Manual Installation
Download the files and include 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:
Or set the environment variable globally.
For example, to set a temporary environment variable:
-
On Mac or Linux:
- On Windows:
And then you can simply initialize $apiInstance
as follows:
Getting Started
Please follow the installation procedure and then run the following:
API Endpoints
All URIs are relative to https://api.cloudinary.com/v2/analysis/CLOUD_NAME/analyze, except if the operation defines another base path.
Class | Method | HTTP request | Description |
---|---|---|---|
AnalysisApi | analyzeAiVisionGeneral | POST /ai_vision_general | Analyze - AI Vision General |
AnalysisApi | analyzeAiVisionModeration | POST /ai_vision_moderation | Analyze - AI Vision Moderation |
AnalysisApi | analyzeAiVisionTagging | POST /ai_vision_tagging | Analyze - AI Vision Tagging |
AnalysisApi | analyzeCaptioning | POST /captioning | Analyze - Captioning |
AnalysisApi | analyzeCldFashion | POST /cld_fashion | Analyze - Cld-Fashion |
AnalysisApi | analyzeCldText | POST /cld_text | Analyze - Cld-Text |
AnalysisApi | analyzeCoco | POST /coco | Analyze - Coco |
AnalysisApi | analyzeCustom | POST /custom | Analyze - custom model |
AnalysisApi | analyzeGoogleTagging | POST /google_tagging | Analyze - Google Tagging |
AnalysisApi | analyzeHumanAnatomy | POST /human_anatomy | Analyze - Human Anatomy |
AnalysisApi | analyzeLvis | POST /lvis | Analyze - Lvis |
AnalysisApi | analyzeShopClassifier | POST /shop_classifier | Analyze - Shop Classifier |
AnalysisApi | analyzeUnidet | POST /unidet | Analyze - Unidet |
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:
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
All versions of analysis with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.4.5
guzzlehttp/psr7 Version ^2.0