Endpoints - Get

Referencia

Servicio:: Azure AI Services

Versión de la API:: v3.2-preview.2

Obtiene el punto de conexión identificado por el identificador especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/{id}

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://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	Identificador del extremo.

Respuestas

Nombre	Tipo	Description
200 OK	Endpoint	Aceptar Encabezados Retry-After: integer
Other Status Codes	Error	Se produjo un error.

Nombre

Tipo

Description

200 OK

Endpoint

Aceptar

Encabezados

Retry-After: integer

Other Status Codes

Error

Se produjo un error.

Seguridad

Ocp-Apim-Subscription-Key

Proporcione aquí la clave de la cuenta de Cognitive Services.

Tipo: apiKey
En: header

Authorization

Proporcione un token de acceso del JWT devuelto por el STS de esta región. Asegúrese de agregar el ámbito de administración al token agregando la siguiente cadena de consulta a la dirección URL de STS: ?scope=speechservicesmanagement.

Tipo: apiKey
En: header

Ejemplos

Get an endpoint

Solicitud de ejemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

Respuesta de muestra

status code:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Definiciones

Nombre	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Punto de conexión
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
Status	Estado

DetailedErrorCode

Nombre	Tipo	Description
DataImportFailed	string	Error en la importación de datos.
DeleteNotAllowed	string	No se permite eliminar.
DeployNotAllowed	string	No se permite la implementación.
DeployingFailedModel	string	Error al implementar el modelo.
EmptyRequest	string	Solicitud vacía.
EndpointCannotBeDefault	string	El punto de conexión no puede ser predeterminado.
EndpointNotUpdatable	string	Punto de conexión no actualizable.
EndpointWithoutLogging	string	Punto de conexión sin registro.
ExceededNumberOfRecordingsUris	string	Se superó el número de URI de grabaciones.
FailedDataset	string	Conjunto de datos con errores.
Forbidden	string	Prohibido.
InUseViolation	string	En infracción de uso.
InaccessibleCustomerStorage	string	Almacenamiento de cliente inaccesible.
InvalidAdaptationMapping	string	Asignación de adaptación no válida.
InvalidBaseModel	string	Modelo base no válido.
InvalidCallbackUri	string	URI de devolución de llamada no válido.
InvalidCollection	string	Colección no válida.
InvalidDataset	string	Conjunto de datos no válido.
InvalidDocument	string	Documento no válido.
InvalidDocumentBatch	string	Lote de documentos no válido.
InvalidLocale	string	Configuración regional no válida.
InvalidLogDate	string	Fecha de registro no válida.
InvalidLogEndTime	string	Hora de finalización del registro no válida.
InvalidLogId	string	Identificador de registro no válido.
InvalidLogStartTime	string	Hora de inicio del registro no válida.
InvalidModel	string	Modelo no válido.
InvalidModelUri	string	URI de modelo no válido.
InvalidParameter	string	Parámetro no válido.
InvalidParameterValue	string	Valor de parámetro no válido.
InvalidPayload	string	Carga no válida.
InvalidPermissions	string	Permisos no válidos.
InvalidPrerequisite	string	Requisito previo no válido.
InvalidProductId	string	Id. de producto no válido.
InvalidProject	string	Proyecto no válido.
InvalidProjectKind	string	Tipo de proyecto no válido.
InvalidRecordingsUri	string	URI de grabaciones no válidos.
InvalidRequestBodyFormat	string	Formato de cuerpo de la solicitud no válido.
InvalidSasValidityDuration	string	Duración de validez de sas no válida.
InvalidSkipTokenForLogs	string	Token de omisión no válido para los registros.
InvalidSourceAzureResourceId	string	Identificador de recurso de Azure de origen no válido.
InvalidSubscription	string	Suscripción no válida.
InvalidTest	string	Prueba no válida.
InvalidTimeToLive	string	Tiempo de vida no válido.
InvalidTopForLogs	string	Top no válido para los registros.
InvalidTranscription	string	Transcripción no válida.
InvalidWebHookEventKind	string	Tipo de evento web hook no válido.
MissingInputRecords	string	Faltan registros de entrada.
ModelCopyOperationExists	string	Existe la operación de copia del modelo.
ModelDeploymentNotCompleteState	string	La implementación del modelo no está completa.
ModelDeprecated	string	Modelo en desuso.
ModelExists	string	El modelo existe.
ModelMismatch	string	Error de coincidencia del modelo.
ModelNotDeployable	string	El modelo no se puede implementar.
ModelVersionIncorrect	string	La versión del modelo es incorrecta.
NoUtf8WithBom	string	No hay utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Solo una de las direcciones URL o el contenedor o el conjunto de datos.
ProjectGenderMismatch	string	Error de coincidencia de género del proyecto.
QuotaViolation	string	Infracción de cuota.
SingleDefaultEndpoint	string	Punto de conexión predeterminado único.
SkuLimitsExist	string	Existen límites de SKU.
SubscriptionNotFound	string	No se encontró la suscripción.
UnexpectedError	string	error inesperado.
UnsupportedClassBasedAdaptation	string	Adaptación basada en clases no admitida.
UnsupportedDelta	string	Delta no admitido.
UnsupportedDynamicConfiguration	string	Configuración dinámica no admitida.
UnsupportedFilter	string	Filtro no admitido.
UnsupportedLanguageCode	string	Código de idioma no admitido.
UnsupportedOrderBy	string	Orden no admitido por.
UnsupportedPagination	string	Paginación no admitida.
UnsupportedTimeRange	string	Intervalo de tiempo no admitido.

Endpoint

Punto de conexión

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).
customProperties	object	Propiedades personalizadas de esta entidad. La longitud máxima permitida de la clave es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es 10.
description	string	Descripción del objeto .
displayName	string	Nombre para mostrar del objeto.
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).
links	EndpointLinks	EndpointLinks
locale	string	Configuración regional de los datos contenidos.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string	Ubicación de esta entidad.
status	Status	Estado Describir el estado actual de la API
text	string	Texto que se usa para adaptar un modelo de lenguaje para este punto de conexión.

EndpointLinks

Nombre	Tipo	Description
logs	string	Los registros de audio y transcripción de este punto de conexión. Consulte la operación "Endpoints_ListLogs" para obtener más detalles.
restConversation	string	Punto de conexión REST para solicitudes de hasta 60 segundos.
restDictation	string	El punto de conexión REST para solicitudes de hasta 60 segundos, lo que admite el dictado de signos de puntuación.
restInteractive	string	Punto de conexión REST para solicitudes cortas de hasta 15 segundos.
webSocketConversation	string	El punto de conexión del SDK de Voz para solicitudes largas con varios resultados finales.
webSocketDictation	string	El punto de conexión del SDK de Voz para solicitudes largas con varios resultados finales, lo que admite el dictado de signos de puntuación.
webSocketInteractive	string	El punto de conexión del SDK de Voz para solicitudes cortas de hasta 15 segundos con un único resultado final.

EndpointProperties

Nombre	Tipo	Description
email	string	Dirección de correo electrónico a la que se enviarán notificaciones por correo electrónico en caso de que se complete la operación. El valor se quitará después de enviar correctamente el correo electrónico.
error	EntityError	EntityError
loggingEnabled	boolean	Valor que indica si se usa el registro de contenido (transcripciones de & de audio) para una implementación.
timeToLive	string	Cuánto tiempo se conservará el punto de conexión en el sistema. Una vez que el punto de conexión alcanza el período de vida después de la finalización (correcto o con errores), se eliminará automáticamente. Si no se establece este valor o se establece en 0, se deshabilitará la eliminación automática. La duración admitida más larga es de 31 días. La duración se codifica como duración ISO 8601 ("PnYnMnDTnHnMnS", vea https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Nombre	Tipo	Description
code	string	Código de este error.
message	string	Mensaje de este error.

EntityReference

Nombre	Tipo	Description
self	string	Ubicación de la entidad a la que se hace referencia.

Error

Nombre	Tipo	Description
code	ErrorCode	ErrorCode Códigos de error de alto nivel.
details	Error[]	Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.
innerError	InnerError	InnerError Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API, que está disponible en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).
message	string	Mensaje de error de alto nivel.
target	string	Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

ErrorCode

Nombre	Tipo	Description
Conflict	string	Representa el código de error en conflicto.
Forbidden	string	Representa el código de error prohibido.
InternalCommunicationFailed	string	Representando el código de error de comunicación interna con errores.
InternalServerError	string	Representa el código de error interno del servidor.
InvalidArgument	string	Representa el código de error de argumento no válido.
InvalidRequest	string	Representa el código de error de solicitud no válido.
NotAllowed	string	Representa el código de error no permitido.
NotFound	string	Representa el código de error no encontrado.
PipelineError	string	Representa el código de error de canalización.
ServiceUnavailable	string	Representa el código de error no disponible del servicio.
TooManyRequests	string	Representa el código de error demasiadas solicitudes.
Unauthorized	string	Representa el código de error no autorizado.
UnprocessableEntity	string	Representa el código de error de entidad noprocesable.
UnsupportedMediaType	string	Representa el código de error de tipo de medio no admitido.

InnerError

Nombre	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeración detallada del código de error.
details	object	Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.
innerError	InnerError	InnerError Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API, que está disponible en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).
message	string	Mensaje de error de alto nivel.
target	string	Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

Status

Estado

Nombre	Tipo	Description
Failed	string	Error en la operación de larga duración.
NotStarted	string	La operación de larga duración aún no se ha iniciado.
Running	string	La operación de larga duración se está procesando actualmente.
Succeeded	string	La operación de larga duración se ha completado correctamente.

Compartir a través de

Endpoints - Get

Parámetros de identificador URI

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Authorization

Ejemplos

Get an endpoint

Solicitud de ejemplo

Respuesta de muestra

Definiciones

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

Recursos adicionales