Endpoints - Create

Referencia

Servicio:: Azure AI Services

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

Crea un nuevo punto de conexión.

PUT {endpoint}/customvoice/endpoints/{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 (uuid)	Identificador de recurso, que debe ser UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta 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 minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	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.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
modelId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
description		string	Descripción del punto de conexión
displayName		string minLength: 1	Nombre del punto de conexión
id		string (uuid)	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 Encabezados Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Error. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

201 Created

Endpoint

Creado

Encabezados

Operation-Id: string
Operation-Location: string

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

Create an endpoint

Solicitud de ejemplo

HTTP

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



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

Respuesta de muestra

status code:: 201

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

{
  "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 el código de error de las propiedades necesarias, el mensaje y el destino de propiedades opcionales, error interno (esto se puede anidar).
Status	Estado de un recurso.

Endpoint

Object

Endpoint (objeto)

Nombre	Tipo	Description
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 del punto de conexión
displayName	string minLength: 1	Nombre del punto de conexión
id	string (uuid)	Id. de punto de conexión
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).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Identificador de recurso
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	EndpointProperties	Propiedades del punto de conexión
status	Status	Estado de un recurso.

EndpointKind

Enumeración

Tipo de punto de conexión

Valor	Description
FastResume
HighPerformance

EndpointProperties

Object

Propiedades del punto de conexión

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

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.

Status

Enumeración

Estado de un recurso.

Valor	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Compartir a través de

Endpoints - Create

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Create an endpoint

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Recursos adicionales