Compartir a través de


Consents - Create

Crea un nuevo consentimiento de talento de voz con la dirección URL de audio proporcionada.

PUT {endpoint}/customvoice/consents/{id}?api-version=2024-02-01-preview

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://eastus.api.cognitive.microsoft.com).

id
path True

string

Identificador del recurso.

Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version
query True

string

Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre Requerido Tipo Description
Ocp-Apim-Subscription-Key True

string

Proporcione la clave del recurso de voz aquí.

Operation-Id

string

Identificador del monitor de estado de la operación. Si el encabezado Operation-Id coincide con una operación existente y la solicitud no es idéntica a la solicitud anterior, se producirá un error con una solicitud incorrecta 400.

Patrón de Regex: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Cuerpo de la solicitud

Nombre Requerido Tipo Description
companyName True

string

Nombre de la compañía. Debe coincidir con el nombre de la empresa en el archivo de audio de consentimiento.

locale True

string

Configuración regional de este consentimiento. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.

projectId True

string

Identificador de recurso

voiceTalentName True

string

Nombre del actor de voz. Debe coincidir con el nombre del actor de voz en el archivo de audio de consentimiento.

audioUrl

string

Dirección URL pública accesible del archivo de audio de consentimiento. Se recomienda ser una dirección URL de blob de Azure con SAS. Esta propiedad solo está disponible en la solicitud.

description

string

Descripción del consentimiento.

displayName

string

Nombre del consentimiento.

id

string

Identificador de recurso

properties

ConsentProperties

Propiedades de consentimiento

status

Status

Estado de un recurso.

Respuestas

Nombre Tipo Description
201 Created

Consent

Creado

Encabezados

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

Se produjo un error.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave del recurso de voz aquí.

Tipo: apiKey
En: header

Ejemplos

Solicitud de ejemplo

PUT {endpoint}/customvoice/consents/Jessica?api-version=2024-02-01-preview



{
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "locale": "en-US"
}

Respuesta de muestra

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314
{
  "id": "Jessica",
  "description": "Consent for Jessica voice",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith",
  "companyName": "Contoso",
  "locale": "en-US",
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definiciones

Nombre Description
Consent

Consent (objeto)

ConsentFailureReason

Motivo del error de creación del consentimiento

ConsentProperties

Propiedades de consentimiento

Error

El error de nivel superior se rige por las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.

ErrorCode

Código de error de nivel superior

ErrorResponse

La respuesta de error sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

InnerError

El error interno sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).

Status

Estado de un recurso.

Consent (objeto)

Nombre Tipo Description
audioUrl

string

Dirección URL pública accesible del archivo de audio de consentimiento. Se recomienda ser una dirección URL de blob de Azure con SAS. Esta propiedad solo está disponible en la solicitud.

companyName

string

Nombre de la compañía. Debe coincidir con el nombre de la empresa en el archivo de audio de consentimiento.

createdDateTime

string

Marca de tiempo cuando se creó el objeto. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)

description

string

Descripción del consentimiento.

displayName

string

Nombre del consentimiento.

id

string

Identificador de recurso

lastActionDateTime

string

Marca de tiempo cuando se especificó el estado actual. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

locale

string

Configuración regional de este consentimiento. El código de configuración regional sigue A BCP-47. Puede encontrar el texto en la lista de configuración regional de voz aquí https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.

projectId

string

Identificador de recurso

properties

ConsentProperties

Propiedades de consentimiento

status

Status

Estado de un recurso.

voiceTalentName

string

Nombre del actor de voz. Debe coincidir con el nombre del actor de voz en el archivo de audio de consentimiento.

ConsentFailureReason

Motivo del error de creación del consentimiento

Nombre Tipo Description
AudioAndScriptNotMatch

string

El audio de consentimiento no coincide con la declaración verbal. Por favor, compruebe la declaración verbal.

Internal

string

Error del servicio de voz personalizado.

ConsentProperties

Propiedades de consentimiento

Nombre Tipo Description
failureReason

ConsentFailureReason

Motivo del error de creación del consentimiento

Error

El error de nivel superior se rige por las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.

Nombre Tipo Description
code

ErrorCode

Código de error de nivel superior

details

Error[]

Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.

innererror

InnerError

El error interno sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).

message

string

Mensaje de error de nivel superior.

target

string

Origen del error. Por ejemplo, sería "model" o "model id" en caso de modelo no válido.

ErrorCode

Código de error de nivel superior

Nombre Tipo Description
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

La respuesta de error sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nombre Tipo Description
error

Error

El error de nivel superior se rige por las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un error de nivel superior con código de error, mensaje, detalles, destino y un error interno con detalles más descriptivos.

InnerError

El error interno sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).

Nombre Tipo Description
code

string

Código de error detallado para ayudar al diagnóstico.

innererror

InnerError

El error interno sigue las directrices de la API REST de Microsoft Azure, que está disponible en https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene el código de error de las propiedades necesarias, el mensaje y el destino de las propiedades opcionales, error interno (se puede anidar).

message

string

Mensaje de error detallado.

target

string

Origen del error. Por ejemplo, sería "model" o "model id" en caso de modelo no válido.

Status

Estado de un recurso.

Nombre Tipo Description
Disabled

string

Disabling

string

Failed

string

NotStarted

string

Running

string

Succeeded

string