SetAIAgentVoiceprint

更新时间:
复制 MD 格式

Registers a voiceprint.

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:SetAIAgentVoiceprint

none

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

VoiceprintId

string

No

A unique identifier for the voiceprint. Generate this ID based on your own business rules. Requirement: 1 to 127 characters in length.

vp_1699123456_8527

Input

object

No

The input file.

Type

string

No

Specifies the access type for the audio file. The system will verify file accessibility via HEAD or GET requests. Valid values:

  • url: An HTTP(S) link to the audio file.

  • oss: An OSS object. Supports the following formats:

    1. OSS URI: oss://bucket-name/object-key

      Example: oss://my-bucket/audio/sample.wav

    2. OSS public URL: http(s)://${bucket}.oss-${region}.aliyuncs.com/${object}

      Example: https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav

Note

The OSS bucket must be in the same region as the service. Otherwise, the access fails.

url

Data

string

No

The media access link.

https://my-bucket.oss-cn-hangzhou.aliyuncs.com/audio/sample.wav

Format

string

No

The audio file format. Only WAV is supported.

wav

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

550e8400********55440000

VoiceprintId

string

The ID of the registered voiceprint.

vp_1699123456_8527

Examples

Success response

JSON format

{
  "RequestId": "550e8400********55440000",
  "VoiceprintId": "vp_1699123456_8527"
}

Error codes

HTTP status code

Error code

Error message

Description

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.