Personal Voices - List

Servicio:: Azure AI Services

Versión de la API:: 2024-02-01-preview

Obtiene una lista de voces personales para el recurso del servicio voz autenticado.

GET {endpoint}/customvoice/personalvoices?api-version=2024-02-01-preview

Con parámetros opcionales:

GET {endpoint}/customvoice/personalvoices?skip={skip}&maxpagesize={maxpagesize}&filter={filter}&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).
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.
filter	query		string	Condición de filtro. Propiedades admitidas: projectId, createdDateTime, configuración regional, tipo Operadores de : eq, ne se admiten para todas las propiedades. gt, ge, lt, le son compatibles con createdDateTime. Ejemplo de : `filter=projectId eq 'Jessica'` (filtrar por identificador de proyecto) `filter=kind eq 'ProfessionalVoice'` (filtrar proyecto por tipo) `filter=locale eq 'en-US'` (modelo y conjunto de entrenamiento de filtro por configuración regional) `filter=createdDateTime gt 2022-12-30T23:59:59.99Z` (tiempo de creación del recurso de filtro después de 2023-11-01)
maxpagesize	query		integer (int32)	Número máximo de elementos que se van a incluir en una sola respuesta.
skip	query		integer (int32)	Número de elementos de resultado que se van a omitir.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Proporcione la clave de recurso de voz aquí.

Respuestas

Nombre	Tipo	Description
200 OK	PaginatedPersonalVoices	Éxito
Other Status Codes	ErrorResponse	Error. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

PaginatedPersonalVoices

Éxito

Other Status Codes

ErrorResponse

Error.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave de recurso de voz aquí.

Tipo: apiKey
En: header

Ejemplos

Get all personal voices

Solicitud de ejemplo

HTTP

GET {endpoint}/customvoice/personalvoices?api-version=2024-02-01-preview

Respuesta de muestra

status code:: 200

{
  "value": [
    {
      "id": "Jessica-PersonalVoice",
      "speakerProfileId": "3059912f-a3dc-49e3-bdd0-02e449df1fe3",
      "projectId": "PersonalVoice",
      "consentId": "Jessica",
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    },
    {
      "id": "Jessica-PersonalVoice",
      "speakerProfileId": "3059912f-a3dc-49e3-bdd0-02e449df1fe3",
      "projectId": "PersonalVoice",
      "consentId": "Jessica",
      "status": "NotStarted",
      "createdDateTime": "2023-04-01T05:30:00.000Z",
      "lastActionDateTime": "2023-04-02T10:15:30.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/customvoice/personalvoices?skip=2&maxpagesize=2&api-version=2024-02-01-preview"
}

Definiciones

Nombre	Description
AzureBlobContentSource	Contenido de Azure Blob Storage. Con los ejemplos a continuación, representa archivos `https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav`
Error	El error de nivel superior sigue las directrices de la API REST de Microsoft Azure que están disponibles 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 propiedades opcionales, error interno (esto se puede anidar).
ModelFailureReason	Motivo del error de entrenamiento del modelo
PaginatedPersonalVoices	Lista de voz personal paginada
PersonalVoice	Objeto de voz personal
PersonalVoiceProperties	Propiedades personales de voz
Status	Estado de un recurso.

AzureBlobContentSource

Object

Contenido de Azure Blob Storage. Con los ejemplos a continuación, representa archivos https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav

Nombre	Tipo	Description
containerUrl	string (url)	Dirección URL del contenedor de Azure Blob Storage con SAS. Necesita permisos de lectura y lista.
extensions	string[]	Extensiones de nombre de archivo.
prefix	string	Prefijo de nombre de blob.

Error

Object

El error de nivel superior sigue las directrices de la API REST de Microsoft Azure que están disponibles 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 de apoyo adicionales 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 propiedades opcionales, error interno (esto se puede anidar).
message	string	Mensaje de error de nivel superior.
target	string	Origen del error. Por ejemplo, sería "modelo" o "id. de modelo" en caso de modelo no válido.

ErrorCode

Enumeración

Código de error de nivel superior

Valor	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

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 sigue las directrices de la API REST de Microsoft Azure que están disponibles 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

Object

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 propiedades opcionales, error interno (esto 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 propiedades opcionales, error interno (esto se puede anidar).
message	string	Mensaje de error detallado.
target	string	Origen del error. Por ejemplo, sería "modelo" o "id. de modelo" en caso de modelo no válido.

ModelFailureReason

Enumeración

Motivo del error de entrenamiento del modelo

Valor	Description
InaccessibleCustomerStorage	El cliente usa Bring Your Own Storage en la cuenta de voz. Pero el almacenamiento no es accesible ahora. Consulte documento.
Internal	Error del servicio de voz personalizado.
SpeakerVerificationFailed	El consentimiento y el audio de entrenamiento no proceden del mismo altavoz.
TerminateByUser	El cliente canceló el entrenamiento del modelo.

PaginatedPersonalVoices

Object

Lista de voz personal paginada

Nombre	Tipo	Description
nextLink	string (uri)	Vínculo a la página siguiente.
value	PersonalVoice[]	Lista de voz personal

PersonalVoice

Object

Objeto de voz personal

Nombre	Tipo	Description
audios	AzureBlobContentSource	Contenido de Azure Blob Storage. Con los ejemplos a continuación, representa archivos `https://contoso.blob.core.windows.net/voicecontainer/jessica/*.wav`
consentId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
createdDateTime	string (date-time)	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 de voz personal
displayName	string minLength: 1	Nombre para mostrar de voz personal
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
lastActionDateTime	string (date-time)	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).
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
properties	PersonalVoiceProperties	Propiedades personales de voz
speakerProfileId	string (uuid)	Identificador de perfil del hablante de voz personal. Rellene esta propiedad en SSML.
status	Status	Estado de un recurso.

PersonalVoiceProperties

Object

Propiedades personales de voz

Nombre	Tipo	Description
failureReason	ModelFailureReason	Motivo del error de entrenamiento del modelo

Status

Enumeración

Estado de un recurso.

Valor	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Compartir a través de

Personal Voices - List

Parámetros de identificador URI

Encabezado de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Get all personal voices

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AzureBlobContentSource

Error

ErrorCode

ErrorResponse

InnerError

ModelFailureReason

PaginatedPersonalVoices

PersonalVoice

PersonalVoiceProperties

Status