Endpoints - Create

Service:

Cognitive Services - Custom Voice

API Version:

2023-12-01-preview

Crea un nuevo punto de conexión.

PUT {endpoint}/customvoice/endpoints/{id}?api-version=2023-12-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 uuid	Identificador de recurso, que debe ser UUID.
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 de 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. Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
modelId	True	string	Identificador de recurso
projectId	True	string	Identificador de recurso
description		string	Descripción del punto de conexión
displayName		string	El nombre del punto de conexión
id		string	Id. de punto de conexión
properties		EndpointProperties	Propiedades del punto de conexión
status		Status	Estado de un recurso.

Respuestas

Nombre	Tipo	Description
201 Created	Endpoint	Creado Headers Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Se produjo un error.

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave de recurso de Voz aquí.

Type: apiKey
In: header

Ejemplos

Create an endpoint

Sample Request

HTTP

PUT {
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb?api-version=2023-12-01-preview



{
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica"
}

Sample Response

Status code:

201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/2595b58d-40d6-4032-a618-482dcce1c130?api-version=2023-12-01-preview
Operation-Id: 2595b58d-40d6-4032-a618-482dcce1c130

Response Body

{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "NotStarted",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definiciones

Nombre	Description
Endpoint	Endpoint (objeto)
EndpointKind	Tipo de punto de conexión
EndpointProperties	Propiedades del punto de conexión
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 código de error de propiedades necesarias, mensaje y destino de propiedades opcionales, error interno (esto se puede anidar).
Status	Estado de un recurso.

Endpoint

Endpoint (objeto)

Nombre	Tipo	Description
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 punto de conexión
displayName	string	El nombre del punto de conexión
id	string	Id. de punto de conexión
lastActionDateTime	string	Marca de tiempo en la que 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).
modelId	string	Identificador de recurso
projectId	string	Identificador de recurso
properties	EndpointProperties	Propiedades del punto de conexión
status	Status	Estado de un recurso.

EndpointKind

Tipo de punto de conexión

Nombre	Tipo	Description
FastResume	string
HighPerformance	string

EndpointProperties

Propiedades del punto de conexión

Nombre	Tipo	Description
kind	EndpointKind	Tipo de punto de conexión

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.

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 código de error de propiedades necesarias, mensaje y 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 "model" o "id. de modelo" 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 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

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 código de error de propiedades necesarias, mensaje y 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 código de error de propiedades necesarias, mensaje y 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 "model" o "id. de modelo" 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