Alibaba Cloud Visual Intelligence Open Platform

https://help.aliyun.com/zh/viapi/developer-reference/
Admin
Alibaba Cloud Visual Intelligence Open Platform provides AI-powered visual recognition and...
Tokens:696,572
Snippets:1,643
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### HTTP Request Example for Object Detection

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-b68b50

This snippet shows a sample HTTP GET request to the Aliyun Object Detection API. It includes the endpoint, action, and an example ImageURL. Common request parameters are indicated by '<公共请求参数>'.

```http
http(s)://objectdet.cn-shanghai.aliyuncs.com/?Action=DetectObject    //更多关于访问域名（Endpoint）信息，请参见：https://help.aliyun.com/document_detail/143103.html
&ImageURL=http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/objectdet/DetectObject/DetectObject1.jpg
&<公共请求参数>
```

--------------------------------

### Compile and Install C++ SDK for Image Segmentation (Linux)

Source: https://help.aliyun.com/zh/viapi/developer-reference/c-old

This section outlines the steps to compile and install the C++ SDK for Alibaba Cloud's Visual Intelligence Open Platform, specifically using image segmentation (imageseg) as an example. It details obtaining AccessKey, installing the SDK and its dependencies (libcurl, libssl, libuuid, libjsoncpp), cloning the SDK repository, and using CMake to build and install the SDK.

```shell
sudo apt-get install libcurl4-openssl-dev libssl-dev uuid-dev libjsoncpp-dev
```

```shell
git clone https://github.com/aliyun/aliyun-openapi-cpp-sdk.git
```

```shell
cd aliyun-openapi-cpp-sdk
mkdir sdk_build
cd sdk_build
cmake -DBUILD_PRODUCT=imageseg -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr
make
sudo make install
```

--------------------------------

### Python SDK Installation for Face and Body

Source: https://help.aliyun.com/zh/viapi/developer-reference/app-authentication-access-tutorial

This command installs the Aliyun Facebody SDK for Python. After installation, you can use the SDK to integrate face and body analysis features into your Python applications. This is a direct installation via pip.

```bash
pip install alibabacloud_facebody20191230
```

--------------------------------

### Install Aliyun SDK Packages using Pip

Source: https://help.aliyun.com/zh/viapi/developer-reference/python

This section lists the pip installation commands for various Aliyun Vision AI services. It recommends installing only the necessary SDK packages for your specific use case.

```bash
pip install alibabacloud_facebody20191230
pip install alibabacloud_ocr20191230
pip install alibabacloud_goodstech20191230
pip install alibabacloud_imageaudit20191230
pip install alibabacloud_imagerecog20190930
pip install alibabacloud_imageenhan20190930
pip install alibabacloud_imageseg20191230
pip install alibabacloud_objectdet20191230
pip install alibabacloud_imageprocess20200320
pip install alibabacloud_imgsearch20200320
pip install alibabacloud_videorecog20200320
pip install alibabacloud_videoenhan20200320
pip install alibabacloud_videoseg20200320
pip install alibabacloud_viapi20230117
pip install alibabacloud_facebody20200910
```

--------------------------------

### Compile Example C++ Code for Image Segmentation

Source: https://help.aliyun.com/zh/viapi/developer-reference/c-old

This command compiles the C++ example code that utilizes the Alibaba Cloud SDK for image segmentation. It links the necessary SDK libraries to create an executable file. Ensure that the example code is saved as 'test.cpp' and that the SDK has been installed correctly.

```shell
g++ -o test.out test.cpp --std=c++11 -lalibabacloud-sdk-core -l alibabacloud-sdk-imageseg
```

--------------------------------

### Install Alibaba Cloud SDK for PHP using Composer

Source: https://help.aliyun.com/zh/viapi/developer-reference/php-version

This snippet demonstrates how to install the Alibaba Cloud SDK for PHP using Composer. It includes commands for installing the full SDK package or specific AI service packages. Ensure Composer is installed first.

```bash
curl -sS https://getcomposer.org/installer | php
php composer.phar require alibabacloud/sdk
# Or for a specific service, e.g., facebody:
php composer.phar require alibabacloud/facebody
```

--------------------------------

### Install Aliyun Python SDK for Image Recognition

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Installs the specific Python SDK package for the Image Recognition service. This SDK allows applications to identify objects, scenes, and concepts within images. Use pip for installation.

```bash
pip install aliyun-python-sdk-imagerecog
```

--------------------------------

### Install Aliyun Python SDK Core Library

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Installs the core library required for all Alibaba Cloud Python SDKs. This package provides fundamental functionalities for interacting with Alibaba Cloud services. It is recommended to use pip for installation.

```bash
pip install aliyun-python-sdk-core
```

--------------------------------

### Python SDK Installation

Source: https://help.aliyun.com/zh/viapi/developer-reference/the-server-access-tutorial

Instructions for installing the Face Body Detection Python SDK using pip.

```APIDOC
## Python SDK Installation

### Description
Install the Face Body Detection Python SDK by running the following command in your terminal.

### Method
PIP Installation

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
pip install alibabacloud_facebody20200910
```

### Response
N/A
```

--------------------------------

### HTTP Request Example for Text Recognition API

Source: https://help.aliyun.com/zh/viapi/developer-reference/the-public-request-parameters-7

This snippet demonstrates a typical HTTP GET request to an Alibaba Cloud Vision Intelligence API endpoint. It includes essential common request parameters for authentication, action specification, formatting, and timestamps. The example shows how to construct the URL with these parameters, which are crucial for making successful API calls.

```HTTP
http://ocr.cn-shanghai.aliyuncs.com/?Signature=NAxwl1W9ROkidJfGeZrsKUXw%2BQ****
&AccessKeyId=testId
&Action=RecognizeBankCard
&Format=JSON
&RegionId=cn-shanghai
&SignatureMethod=HMAC-SHA1
&SignatureNonce=313ef0fb-0393-464f-a6e2-59d9ca2585b1
&SignatureVersion=1.0
&Timestamp=2019-10-12T08%3A18%3A18Z
&Version=2019-12-30
```

--------------------------------

### 添加Java SDK依赖

Source: https://help.aliyun.com/zh/viapi/developer-reference/the-server-access-tutorial

在Java项目中添加人脸人体服务的POM依赖，用于通过服务端SDK进行API调用。请根据实际项目情况替换版本号。

```xml
<!-- https://mvnrepository.com/artifact/com.aliyun/facebody20200910 -->
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>facebody20200910</artifactId>
    <version>${aliyun.facebody.version}</version>
</dependency>
```

--------------------------------

### RecognizeVATInvoice HTTP Request Example

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-k4uq3o

This is an example of an HTTP GET request to the Aliyun VIAPI OCR service for recognizing a VAT invoice. It specifies the action, file type, and a file URL. Public request parameters are also indicated.

```http
http(s)://ocr.cn-shanghai.aliyuncs.com/?Action=RecognizeVATInvoice
&FileType=jpg
&FileURL=https://vision.aliyun.com/experience/detail?&tagName=ocr&children=RecognizeVATInvoice
&<公共请求参数>
```

--------------------------------

### Get Async Job Result Response Example (JSON)

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-radiotherapy-lymphatic-station-segmentation

This JSON response example illustrates the result of querying an asynchronous job using the GetAsyncJobResult API. It includes the job status (e.g., PROCESS_SUCCESS) and a 'Result' field containing a URL to the actual processing output, which itself is a JSON string.

```json
{
  "RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
  "Data" : {
    "Status" : "PROCESS_SUCCESS",
    "JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
    "Result" : "{\"ResultURL\":\"http://vibktprfx-prod-prod-med-eas-cn-shanghai.oss-cn-shanghai.aliyuncs.com/seg-organ-ct/2023-03-06/18%3A03%3A28/286574099408093190.nii.gz?Expires=1678098808&OSSAccessKeyId=LTAI****************&Signature=jsPwP7rg4orZQFC6USE3JUOJcS****\"}"
  }
}
```

--------------------------------

### Install Aliyun Python SDK for Goods Understanding

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Installs the specific Python SDK package for the Goods Understanding service. This SDK allows for the analysis and recognition of product images, facilitating features like visual search and product categorization. Use pip for installation.

```bash
pip install aliyun-python-sdk-goodstech
```

--------------------------------

### Install Core .NET SDK using .NET CLI

Source: https://help.aliyun.com/zh/viapi/developer-reference/c-version

Installs the core Alibaba Cloud SDK for .NET using the .NET Command Line Interface (CLI). This is a prerequisite for using other SDK modules.

```bash
dotnet add package aliyun-net-sdk-core
```

--------------------------------

### Query Asynchronous Job Result API Examples (HTTP and JSON)

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-rib-fracture-detection

Provides an example HTTP request to get the result of an asynchronous job using GetAsyncJobResult API, and a corresponding JSON response structure. The response includes status, job ID, and detailed results of the fracture detection, including coordinates and confidence scores.

```http
http(s)://imageprocess.cn-shanghai.aliyuncs.com/?Action=GetAsyncJobResult
&JobId=E75FE679-0303-4DD1-8252-1143B4FA8A27
&<公共请求参数>
```

```json
{
  "RequestId" : "43A0AEB6-45F4-4138-8E89-E1A5D63200E3",
  "Data" : {
    "Status" : "PROCESS_SUCCESS",
    "JobId" : "186AC396-0EEC-46F1-AAA1-BF3585227427",
    "Result" : "{\"Detections\" : \"Coordinates\" : [75,-98,-156,98,-80,-133],\"FractureId\" : 2,\"CoordinateImage\" : [338,137,220,366,159,239],\"FractureConfidence\" : 0.7916666666666667,\"FractureCategory\" : \"1\",\"FractureLocation\" : \"L4\",\"FractureSegment\" : 0,\"FracSOPInstanceUID\" : \"None\",\"Origin\" : [-431.9739990234375,-211.5,-204.01400756835938],\"ResultURL\" : \"http://vibktprfx-prod-prod-aic-med-cn-shanghai.oss-cn-shanghai.aliyuncs.com/detect-rib-fracture/local_test/2020-12-22/result-D5CD101C-F8E5-43CA-9E99-44C783B8F8BE.tar.gz?Expires=1608631727&OSSAccessKeyId=LTAI****************&Signature=d6c32E1IB4b7Ayo1lpjs%2Bq3Ylv****\",\"Spacing\" : [1.25,0.8261719942092896,0.8261719942092896]}"
  }
}
```

--------------------------------

### C++ SDK Example for Image Segmentation

Source: https://help.aliyun.com/zh/viapi/developer-reference/c-old

This C++ code example demonstrates how to use the Alibaba Cloud Visual Intelligence Open Platform SDK to perform image segmentation. It covers initializing the SDK, configuring the client with region and endpoint, setting up credentials (AccessKey ID and Secret from environment variables), creating a request with an image URL, sending the request, and handling the response. Note that this example currently only supports OSS file URLs within the Shanghai region.

```cpp
#include <cstdlib>
#include <iostream>
#include <alibabacloud/core/AlibabaCloud.h>
#include <alibabacloud/imageseg/ImagesegClient.h>

using namespace std;
using namespace AlibabaCloud;
using namespace AlibabaCloud::Imageseg;

int main( int argc, char** argv )
{
    AlibabaCloud::InitializeSdk();

    // 生成客户端配置，此处目前只支持上海region。
    AlibabaCloud::ClientConfiguration configuration( "cn-shanghai" );

    // 为客户端配置设置对应能力的访问域名；
    // 比如图像分割的域名是："imageseg.cn-shanghai.aliyuncs.com"，其他能力请参考对应文档：https://help.aliyun.com/document_detail/143103.html。
    configuration.setEndpoint( "imageseg.cn-shanghai.aliyuncs.com" );

    // 创建AccessKey ID和AccessKey Secret，请参见：https://help.aliyun.com/document_detail/175144.html
    // 如果您使用的是RAM用户的AccessKey，还需要为子账号授予权限AliyunVIAPIFullAccess，请参见：https://help.aliyun.com/document_detail/145025.html
    // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
    AlibabaCloud::Credentials credential( getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET") );
    
    /* use STS Token
    credential.setSessionToken( "<your-sts-token>" );
    */
    ImagesegClient client( credential, configuration );

    Model::SegmentCommonImageRequest request;

    // 此处请填写您的输入图像的OSS地址，目前仅支持在上海region的OSS地址。
    request.setImageURL( "http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/imageseg/SegmentCommonImage/SegmentCommonImage1.jpg" );

    // 客户端执行请求。
    auto outcome = client.segmentCommonImage( request );

    // 判断请求结果是否成功。
    if ( !outcome.isSuccess() )
    {
        // 如果请求结果失败，则打印出对应的错误码和错误信息
        std::cout << outcome.error().errorCode() << ": " << outcome.error().errorMessage() << std::endl;
        AlibabaCloud::ShutdownSdk();
        return(-1);
    }

    // 线上API处理完成之后会返回输入图像处理之后的结果URL，将结果URL输入浏览器您就可以看到处理结果。
    std::cout << "Output imageURL: " << outcome.result().getData().imageURL << std::endl;

    AlibabaCloud::ShutdownSdk();
    return 0;
}

```

--------------------------------

### Python SDK Example: Recognize Bank Card

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Demonstrates how to use the Aliyun Python SDK to recognize bank card information. This example requires the `aliyun-python-sdk-core` and `aliyun-python-sdk-ocr` packages to be installed and environment variables for access keys to be configured. It assumes the input is an OSS file in the same region.

```python
#!/usr/bin/env python
#coding=utf-8

import os
from aliyunsdkcore.client import AcsClient
from aliyunsdkcore.acs_exception.exceptions import ClientException
from aliyunsdkcore.acs_exception.exceptions import ServerException
from aliyunsdkcore.auth.credentials import AccessKeyCredential
from aliyunsdkcore.auth.credentials import StsTokenCredential
from aliyunsdkocr.request.v20191230.RecognizeBankCardRequest import RecognizeBankCardRequest

# Create AccessKey ID and AccessKey Secret, please refer to https://help.aliyun.com/document_detail/175144.html.
# If you are using a RAM user's AccessKey, you also need to grant the RAM user the permission AliyunVIAPIFullAccess, please refer to https://help.aliyun.com/document_detail/145025.html.
# Read AccessKey ID and AccessKey Secret from environment variables. Environment variables must be configured before running the code example.
credentials = AccessKeyCredential(os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'], os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'])
# use STS Token
# credentials = StsTokenCredential(os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'], os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET'], os.environ['ALIBABA_CLOUD_SECURITY_TOKEN'])
client = AcsClient(region_id='cn-shanghai', credential=credentials)

request = RecognizeBankCardRequest()
request.set_accept_format('json')

response = client.do_action_with_exception(request)

```

--------------------------------

### Initialize Aliyun VI API Client with AK/SK in Java

Source: https://help.aliyun.com/zh/viapi/developer-reference/java

This Java code snippet demonstrates how to initialize an Aliyun VI API client using Access Key ID and Access Key Secret. It configures the SDK client with the necessary credentials and the specific endpoint for the desired service, such as OCR in Shanghai. This is a prerequisite for making any API calls.

```java
package com.aliyun.sample;

import com.aliyun.teaopenapi.models.Config;
import com.aliyun.ocr20191230.Client;

public class Sample {

    /**
    * 使用AK&SK初始化账号Client
    * @param accessKeyId
    * @param accessKeySecret
    * @return Client
    * @throws Exception
    */
    // 这里只是以ocr为例，其他能力请使用相应类目的包下面的Client类
    public static Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
        /*
          初始化配置对象com.aliyun.teaopenapi.models.Config
          Config对象存放AccessKeyId、AccessKeySecret、endpoint等配置
         */
        Config config = new Config()
            .setAccessKeyId(accessKeyId)
            .setAccessKeySecret(accessKeySecret);
        
        // 2、访问的域名。注意：这个地方需要求改为相应类目的域名，参考：https://help.aliyun.com/document_detail/143103.html
        config.endpoint = "ocr.cn-shanghai.aliyuncs.com";
        
        // 3、这里只是以ocr为例，其他能力请使用相应类目的包下面的Client类
        return new Client(config);
    }

    public static void main(String[] args) throws Exception {
      
        // 4、"YOUR_ACCESS_KEY_ID", "YOUR_ACCESS_KEY_SECRET" 的生成请参考https://help.aliyun.com/document_detail/175144.html
        // 如果您用的是RAM用户（子账号）AccessKey，还需要为RAM用户（子账号）授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html
        // 这里只是以ocr为例，其他能力请使用相应类目的包下面的Client类

        // 创建AccessKey ID和AccessKey Secret，请参考https://help.aliyun.com/document_detail/175144.html。
        // 如果您使用的是RAM用户的AccessKey，还需要为RAM用户授予权限AliyunVIAPIFullAccess，请参考https://help.aliyun.com/document_detail/145025.html。
        // 从环境变量读取配置的AccessKey ID和AccessKey Secret。运行代码示例前必须先配置环境变量。
        Client client = Sample.createClient(System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
      
        // ... rest of the code to make API calls ...
    }
}

```

--------------------------------

### Configure Environment Variables for AccessKey

Source: https://help.aliyun.com/zh/viapi/developer-reference/node-js

Before installing and using the Aliyun SDK, you must configure environment variables for your AccessKey ID and AccessKey Secret. This guide provides instructions for both Linux/macOS and Windows operating systems.

```APIDOC
## Configure Environment Variables

Set the environment variables `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET`.

**Important:**
*   Your Aliyun AccessKey has full API access permissions. It is recommended to use RAM users for API access or daily operations. Refer to Create a RAM User for details.
*   Do not save your AccessKey ID and AccessKey Secret directly in your project code to prevent potential leaks and security risks.

### Linux and macOS Configuration:

1.  Open the Terminal in IntelliJ IDEA.
2.  Execute the following commands, replacing `<access_key_id>` and `<access_key_secret>` with your RAM user's credentials:
    ```bash
    export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
    export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
    ```
    For further permission-related configurations, see Use RAM Policy to Control Access Permissions.

### Windows System Configuration:

1.  Create a new environment variable file.
2.  Add the environment variables `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET` with your AccessKey ID and Secret.
3.  Restart your Windows system for the changes to take effect. (Example for Windows 10):
    1.  Open File Explorer, right-click **This PC**, and select **Properties**.
    2.  In the right-hand navigation pane, click **Advanced system settings**.
    3.  In the **System Properties** dialog box, on the **Advanced** tab, click **Environment Variables**.
    4.  In the **Environment Variables** dialog box, click **New**.
    5.  In the **New System Variable** dialog box, add `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET`, and enter your AccessKey ID and Secret.
    6.  Restart Windows to apply the configuration.
```

--------------------------------

### Detect Pedestrian API Request Example

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-dk8hnc

This snippet shows a typical HTTP GET request to the Detect Pedestrian API. It includes the endpoint, action, and image URL parameters. For more information on endpoints, refer to the Aliyun documentation.

```http
http(s)://facebody.cn-shanghai.aliyuncs.com/?Action=DetectPedestrian
&ImageURL=http://viapi-test.oss-cn-shanghai.aliyuncs.com/viapi-3.0domepic/facebody/DetectPedestrian/DetectPedestrian8.jpg
&公共请求参数
```

--------------------------------

### Install Aliyun Python SDK for Video Recognition

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Installs the specific Python SDK package for the Video Recognition service. This SDK enables the analysis of video content, including object recognition, scene understanding, and action detection within video streams. Use pip for installation.

```bash
pip install aliyun-python-sdk-videorecog
```

--------------------------------

### Install Aliyun Python SDK for Visual Search

Source: https://help.aliyun.com/zh/viapi/developer-reference/python-version

Installs the specific Python SDK package for the Visual Search service. This SDK allows developers to build applications that can search for similar images based on a query image, leveraging powerful image matching algorithms. Use pip for installation.

```bash
pip install aliyun-python-sdk-imgsearch
```

--------------------------------

### Example HTTP Request for Video Segmentation API

Source: https://help.aliyun.com/zh/viapi/developer-reference/the-public-request-parameters-5

This snippet shows a sample HTTP GET request URL for the SegmentVideoBody API. It includes all necessary common request parameters such as AccessKeyId, Action, Format, RegionId, SignatureMethod, SignatureNonce, SignatureVersion, Timestamp, and Version. The example demonstrates how these parameters are appended to the base API endpoint to form a complete request.

```http
http://videoseg.cn-shanghai.aliyuncs.com/?Signature=NAxwl1W9ROkidJfGeZrsKUXw%2BQ****
&AccessKeyId=testId
&Action=SegmentVideoBody
&Format=JSON
&RegionId=cn-shanghai
&SignatureMethod=HMAC-SHA1
&SignatureNonce=313ef0fb-0393-464f-a6e2-59d9ca2585b1
&SignatureVersion=1.0
&Timestamp=2020-03-10T08%3A18%3A18Z
&Version=2020-03-20
```

--------------------------------

### Generate Super Resolution Image Request Example

Source: https://help.aliyun.com/zh/viapi/developer-reference/api-generated-image-super-score

This snippet shows a sample HTTP GET request to the Aliyun Image Enhancement API for generating a super-resolution image. It includes parameters like Action, ImageUrl, Scale, OutputFormat, and OutputQuality. The endpoint and parameter details can be found in the Aliyun documentation.

```http
http(s)://imageenhan.cn-shanghai.aliyuncs.com/?Action=GenerateSuperResolutionImage
&ImageUrl=https://viapi-test.oss-cn-shanghai.aliyuncs.com/test/xxx/1025.jpg
&Scale=2
&OutputFormat=jpg
&OutputQuality=95
&公共请求参数
```
Tokens:
Raw