README

使用Analyze API分析任何外部资产，并根据请求的分析类型返回详细信息。

目前支持以下分析选项

说明:

Analyze API目前正在开发中，并提供为公共测试版，这意味着我们重视您的反馈，所以请随时与我们分享您的想法。
分析选项需要订阅相关附加组件。了解有关注册附加组件的更多信息。

API支持使用您的Cloudinary API密钥和API密钥（可在仪表板页面找到）进行基本身份验证（HTTPS）或OAuth2（有关OAuth的更多信息，请联系支持）。

有关更多信息，请访问https://cloudinary.com/documentation/analyze_api_reference。

安装与使用

要求

PHP 8.1及更高版本。

Composer

要通过Composer安装绑定，请将以下内容添加到composer.json

{
  "require": {
    "cloudinary/analysis": "*"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/analysis/vendor/autoload.php');

配置

API使用HTTPS进行基本身份验证。

您可以在Cloudinary控制台的API密钥页面找到产品环境配置凭据仪表板。

您可以通过每次初始化$apiInstance时传递配置

<?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);

或全局设置环境变量。

例如，设置临时环境变量

在Mac或Linux上

export CLOUDINARY_URL=cloudinary://key:secret@cloud_name

在Windows上

set CLOUDINARY_URL=cloudinary://key:secret@cloud_name

然后您可以直接初始化$apiInstance如下

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$apiInstance = new Cloudinary\Analysis\Api\AnalysisApi();

入门

请按照安装过程进行，然后运行以下命令

<?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端点

所有URI都是相对于https://api.cloudinary.com/v2/analysis/CLOUD_NAME/analyze，除非操作定义了另一个基本路径。

模型

授权

基本认证

类型：HTTP基本认证

OAuth2

类型：OAuth
流程：accessCode
授权URL：https://oauth.cloudinary.com/oauth2/auth
作用域:
- media_analysis：分析媒体

测试

运行测试，使用

composer install
vendor/bin/phpunit

作者

关于此包

此Analyze API (Beta) PHP包是自动生成的。

包版本：0.1.0
API版本：0.1.0
构建包：org.openapitools.codegen.languages.PhpNextgenClientCodegen

cloudinary / analysis

维护者

详细信息