Create a face database

Updated at:

You can create a face database to store face data. This document provides sample code in popular programming languages to create a face database.

Note
  • For real-time assistance, start an online consultation.

  • If you have questions about API access or usage for the Alibaba Cloud Vision AI Platform, join our DingTalk group (ID: 23109592) to contact us.

Overview

For a functional overview and detailed API parameter descriptions, see CreateFaceDb.

SDK installation

For information about the SDK dependencies for popular programming languages, see SDK overview.

Configure environment variables

Configure the ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET environment variables.

Important
  • An Alibaba Cloud account has full access to all API operations. We recommend that you use a RAM user for API calls or routine O&M. For more information, see Create a RAM user.

  • Do not save your AccessKey ID or AccessKey Secret in project code. Otherwise, the AccessKey pair may be leaked and the security of all resources in your account may be compromised.

  • Configure environment variables on Linux and macOS

    1. Open a terminal in IntelliJ IDEA.

    2. Run the following commands to configure the environment variables.

      Replace <access_key_id> with the AccessKey ID of your RAM user and <access_key_secret> with the AccessKey Secret of your RAM user. If you need to configure more permissions, see Control access permissions using a RAM policy.

      export ALIBABA_CLOUD_ACCESS_KEY_ID=<access_key_id>
      export ALIBABA_CLOUD_ACCESS_KEY_SECRET=<access_key_secret>
  • Configure environment variables on Windows

    Create a new environment variable file, add the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared. Then, restart the Windows operating system. The following example uses Windows 10.

    1. Open File Explorer, right-click This PC, and then select Properties.

    2. In the left-side navigation pane, click Advanced system settings.

    3. On the Advanced tab of the System Properties dialog box, click Environment Variables.

    4. In the Environment Variables dialog box, click New.

    5. In the New System Variable dialog box, add the environment variables ALIBABA_CLOUD_ACCESS_KEY_ID and ALIBABA_CLOUD_ACCESS_KEY_SECRET, and set them to the AccessKey ID and AccessKey Secret that you have prepared.

    6. Restart the Windows operating system for the configurations to take effect.

Sample code

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

import com.aliyun.facebody20191230.models.CreateFaceDbResponse;
import com.aliyun.tea.TeaException;
import com.aliyun.tea.TeaModel;

public class CreateFaceDb {
    public static com.aliyun.facebody20191230.Client createClient(String accessKeyId, String accessKeySecret) throws Exception {
        /*
          Initialize the configuration object com.aliyun.teaopenapi.models.Config.
          This object stores configurations such as your AccessKey ID, AccessKey Secret, and endpoint.
         */
         com.aliyun.teaopenapi.models.Config config = new com.aliyun.teaopenapi.models.Config()
                .setAccessKeyId(accessKeyId)
                .setAccessKeySecret(accessKeySecret);
        // The service endpoint.
        config.endpoint = "facebody.cn-shanghai.aliyuncs.com";
        return new com.aliyun.facebody20191230.Client(config);
    }

    public static void main(String[] args_) throws Exception {
        // For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
        // If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
        // Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code.
        String accessKeyId = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
        String accessKeySecret = System.getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET"); 
        com.aliyun.facebody20191230.Client client = CreateFaceDb.createClient(accessKeyId, accessKeySecret);
        com.aliyun.facebody20191230.models.CreateFaceDbRequest createFaceDbRequest = new com.aliyun.facebody20191230.models.CreateFaceDbRequest()
                .setName("Face1");
        com.aliyun.teautil.models.RuntimeOptions runtime = new com.aliyun.teautil.models.RuntimeOptions();
        try {
            // Add your own print statement to display the API response.
            CreateFaceDbResponse createFaceDbResponse = client.createFaceDbWithOptions(createFaceDbRequest, runtime);
            // Get the full response.
            System.out.println(com.aliyun.teautil.Common.toJSONString(TeaModel.buildMap(createFaceDbResponse)));
        } catch (TeaException teaException) {
            // Get the full error information.
            System.out.println(com.aliyun.teautil.Common.toJSONString(teaException));
            // Get a single field.
            System.out.println(teaException.getCode());
        }
    }
}
# -*- coding: utf-8 -*-
# Install the dependency.
# pip install alibabacloud_facebody20191230

import os
from alibabacloud_facebody20191230.models import CreateFaceDbRequest
from alibabacloud_tea_openapi.models import Config
from alibabacloud_facebody20191230.client import Client
from alibabacloud_tea_util.models import RuntimeOptions

config = Config(
    # For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
    # If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
    # Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code.
    access_key_id=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID'),
    access_key_secret=os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET'),
    # The service endpoint.
    endpoint='facebody.cn-shanghai.aliyuncs.com',
    # The service region.
    region_id='cn-shanghai'
)
runtime_option = RuntimeOptions()
create_face_db_request = CreateFaceDbRequest(
            name='Face1'
        )
try:
  # Initialize the client.
  client = Client(config)
  response = client.create_face_db_with_options(create_face_db_request, runtime_option)
  # Get the full response.
  print(response.body)
except Exception as error:
  # Get the full error information.
  print(error)
  # Get a single field.
  print(error.code)
  # Tip: Use error.__dict__ to view attribute names.
<?php

// Install the dependency.
// composer require alibabacloud/facebody-20191230

use AlibabaCloud\SDK\Facebody\V20191230\Facebody;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Facebody\V20191230\Models\CreateFaceDbRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
use Exception;

class CreateFaceDb {

    /**
     * Use an AccessKey ID and AccessKey Secret to initialize the client.
     * @param string $accessKeyId
     * @param string $accessKeySecret
     * @return Facebody Client
     */
    public static function createClient($accessKeyId, $accessKeySecret){
        // Initialize the configuration object Darabonba\OpenApi\Models\Config.
        // This object stores configurations such as your accessKeyId, accessKeySecret, and endpoint.
        $config = new Config([
            "accessKeyId" => $accessKeyId,
            "accessKeySecret" => $accessKeySecret
        ]);
        // The service endpoint.
        $config->endpoint = "facebody.cn-shanghai.aliyuncs.com";
        return new Facebody($config);
    }
    /**
     * @param string[] $args
     * @return void
     */
    public static function main($args){
        // For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
        // If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
        // Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code.    
        $accessKeyId = getenv('ALIBABA_CLOUD_ACCESS_KEY_ID');      
        $accessKeySecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
        $client = self::createClient($accessKeyId, $accessKeySecret);
        $createFaceDbRequest = new CreateFaceDbRequest([
            "name" => "Face1"
        ]);
        $runtime = new RuntimeOptions([]);
        try {
            $resp = $client->createFaceDbWithOptions($createFaceDbRequest, $runtime);
            # Get the full response.
            echo Utils::toJSONString($resp->body);
        } catch (Exception $exception) {
            # Get the full error information.
            echo Utils::toJSONString($exception);
            # Get a single field.
            echo $exception->getCode();
        }
    }
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
    require_once $path;
}
// $argv is a reserved array for input parameters and requires no modification.
CreateFaceDb::main(array_slice($argv, 1));
// Install the dependency.
// npm install @alicloud/facebody20191230
const FacebodyClient = require('@alicloud/facebody20191230');
const OpenapiClient = require('@alicloud/openapi-client');
const TeaUtil = require('@alicloud/tea-util');

let config = new OpenapiClient.Config({
    // For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
    // If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
    // Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code. 
    accessKeyId: process.env.ALIBABA_CLOUD_ACCESS_KEY_ID,   
    accessKeySecret: process.env.ALIBABA_CLOUD_ACCESS_KEY_SECRET
});
// The service endpoint.
config.endpoint = `facebody.cn-shanghai.aliyuncs.com`;
const client = new FacebodyClient.default(config);
let createFaceDbRequest = new FacebodyClient.CreateFaceDbRequest({
    "name":"Face1"
});
let runtime = new TeaUtil.RuntimeOptions({ });
client.createFaceDbWithOptions(createFaceDbRequest, runtime)
  .then(function(createFaceDbResponse) {
    // Get the full response.
    console.log(createFaceDbResponse);
    // Get a single field.
    console.log(createFaceDbResponse.body.data);
  }, function(error) {
    // Get the full error information.
    console.log(error);
    // Get a single field.
    console.log(error.data.Code);
  })
 /**
 This code depends on github.com/alibabacloud-go/facebody-20191230/v4.
 We recommend that you run `go mod tidy` to install dependencies.
 */

package main

import (
	"fmt"
	"os"
	openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
	facebody20191230 "github.com/alibabacloud-go/facebody-20191230/v4/client"
	util "github.com/alibabacloud-go/tea-utils/v2/service"
	"github.com/alibabacloud-go/tea/tea"
)

func main() {
     // For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
     // If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
     // Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code.
     accessKeyId := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")  
     accessKeySecret := os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")
     // Initialize the configuration object &openapi.Config. This object stores configurations such as your AccessKey ID, AccessKey Secret, and endpoint.
     config := &openapi.Config{
          AccessKeyId: tea.String(accessKeyId),
          AccessKeySecret: tea.String(accessKeySecret),
	   }
	// The service endpoint.
	config.Endpoint = tea.String("facebody.cn-shanghai.aliyuncs.com")
	client, err := facebody20191230.NewClient(config)
	if err != nil {
		panic(err)
	}
	createFaceDbRequest := &facebody20191230.CreateFaceDbRequest{
		Name: tea.String("Face1"),
	}
	runtime := &util.RuntimeOptions{}
	createFaceDbResponse, err := client.CreateFaceDbWithOptions(createFaceDbRequest, runtime)
	if err != nil {
		// Get the full error message.
		fmt.Println(err.Error())
	} else {
		// Get the full response.
		fmt.Println(createFaceDbResponse)
	}
}
// Install the dependency.
// dotnet add package AlibabaCloud.SDK.Facebody20191230
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using AlibabaCloud.SDK.Facebody20191230.Models;
using Tea;
using Tea.Utils;

namespace AlibabaCloud.SDK.Sample
{
    public class Sample
    {

        /**
        * Use an AccessKey ID and AccessKey Secret to initialize the client.
        * @param accessKeyId
        * @param accessKeySecret
        * @return Client
        * @throws Exception
        */
        public static AlibabaCloud.SDK.Facebody20191230.Client CreateClient(string accessKeyId, string accessKeySecret)
        {
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
            {
                AccessKeyId = accessKeyId,
                AccessKeySecret = accessKeySecret,
            };
            // The service endpoint.
            config.Endpoint = "facebody.cn-shanghai.aliyuncs.com";
            return new AlibabaCloud.SDK.Facebody20191230.Client(config);
        }
        public static void Main(string[] args)
        {
            // For information about how to create an AccessKey pair, see https://help.aliyun.com/document_detail/175144.html.
            // If you use a RAM user's AccessKey pair, grant the RAM user the AliyunVIAPIFullAccess permission. For more information, see https://help.aliyun.com/document_detail/145025.html.
            // Read the AccessKey ID and AccessKey Secret from environment variables. Ensure these variables are configured before you run the sample code.
            AlibabaCloud.SDK.Facebody20191230.Client client = CreateClient(System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"), System.Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"));
            AlibabaCloud.SDK.Facebody20191230.Models.CreateFaceDbRequest createFaceDbRequest = new AlibabaCloud.SDK.Facebody20191230.Models.CreateFaceDbRequest{
                Name = "Face1",
            };
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
            try
            {
                AlibabaCloud.SDK.Facebody20191230.Models.CreateFaceDbResponse createFaceDbResponse = client.CreateFaceDbWithOptions(createFaceDbRequest, runtime);
                // Get the full response.
                Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(createFaceDbResponse.Body));
                // Get a single field.
                Console.WriteLine(AlibabaCloud.TeaUtil.Common.ToJSONString(createFaceDbResponse.Body.RequestId));
            }
            catch (TeaException error)
            {
                // If necessary, print the error.
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(new Dictionary<string, object>
                {
                    { "message", _error.Message }
                });
                // If necessary, print the error.
                Console.WriteLine(error.Message);
            }
        }
    }
}

FAQ

Does the face database distinguish between test and production environments?

No. The CreateFaceDb operation only accepts a database name parameter and does not provide an environment type option. To separate test and production scenarios, create separate databases:

# Create a database for testing.
aliyun facebody CreateFaceDb --endpoint facebody.cn-shanghai.aliyuncs.com --Name test_db

# Create a database for production.
aliyun facebody CreateFaceDb --endpoint facebody.cn-shanghai.aliyuncs.com --Name prod_db

# List all databases.
aliyun facebody ListFaceDbs --endpoint facebody.cn-shanghai.aliyuncs.com

On the face database management page of the console, you can switch between databases to view them. For information about capacity limits and QPS limits, see the API reference for CreateFaceDb and the QPS documentation.