CreateRecognitionLib

Updated at:

Creates a custom recognition library to store entity information for recognition.

Operation description

  • This API operation is currently supported only in the China (Beijing), China (Shanghai), China (Hangzhou), and China (Shenzhen) regions.

  • Usage of a self-registered recognition library (using object as an example): Create a custom object library and a custom object entity. After the creation, register images for the custom object entity. After the registration, create Template A that includes the self-registered object library, use Template A to submit an analysis task, and then query the results.

  • The queries per second (QPS) limit per user is 50. If this limit is exceeded, API calls are throttled, which may affect your services. Call this API operation at a reasonable rate. For more information, see QPS limits.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:CreateRecognitionLib

create

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

Algorithm

string

Yes

The recognition type. Valid values:

  • landmark: custom landmark

  • object: custom object

  • logo: custom logo

  • face: custom face

  • label: custom label

landmark

LibName

string

Yes

The name of the recognition library. The name can be up to 64 bytes in length.

landmark test suite

LibDescription

string

No

The description of the recognition library. The description can be up to 128 bytes in length.

Used to store commodity identification samples

Response elements

Element

Type

Description

Example

object

LibId

string

The ID of the created recognition library.

*************24b47865c6**************

RequestId

string

The request ID.

******11-DB8D-4A9A-875B-275798******

Examples

Success response

JSON format

{
  "LibId": "*************24b47865c6**************",
  "RequestId": "******11-DB8D-4A9A-875B-275798******"
}

Error codes

HTTP status code

Error code

Error message

Description

400 InvalidParameter errorMsg:%s
500 InternalError errorMsg:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.