Compartir a través de

Endpoints - List

Servicio:
Azure AI Services
Versión de la API:
v3.2-preview.2

Obtiene la lista de puntos de conexión de la suscripción autenticada.

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints
Con parámetros opcionales: 
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip={skip}&top={top}&filter={filter}

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).
filter
 query

string

Expresión de filtrado para seleccionar un subconjunto de los puntos de conexión disponibles.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime.

          - and, or, not are supported.

        - Example:

          filter=locale eq 'en-US'
skip
 query

integer (int32)

Número de conjuntos de datos que se omitirán.
top
 query

integer (int32)

Número de conjuntos de datos que se incluirán después de omitir.

Respuestas

Nombre Tipo Description
200 OK

PaginatedEndpoints

De acuerdo

Encabezados

Retry-After: integer
Other Status Codes

Error

Se ha producido 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 all endpoints
Get all queued endpoints.

Get all endpoints

Solicitud de ejemplo

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Respuesta de muestra

status code:
200 
{
  "values": [
    {
      "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"
    },
    {
      "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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "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": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

Solicitud de ejemplo

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'

Respuesta de muestra

status code:
200 
{
  "values": [
    {
      "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/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "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": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ]
}

Definiciones

Nombre Description
DetailedErrorCode

DetailedErrorCode
Endpoint

Punto final
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EntityError

EntityError
EntityReference

EntityReference
Error

Error
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedEndpoints

PaginatedEndpoints
Status

Estado

DetailedErrorCode

Enumeración

DetailedErrorCode

Valor Description
InvalidParameterValue

Valor de parámetro no válido.
InvalidRequestBodyFormat

Formato de cuerpo de la solicitud no válido.
EmptyRequest

Solicitud vacía.
MissingInputRecords

Faltan registros de entrada.
InvalidDocument

Documento no válido.
ModelVersionIncorrect

Versión del modelo incorrecta.
InvalidDocumentBatch

Lote de documentos no válido.
UnsupportedLanguageCode

Código de lenguaje no admitido.
DataImportFailed

Error en la importación de datos.
InUseViolation

En infracción de uso.
InvalidLocale

Configuración regional no válida.
InvalidBaseModel

Modelo base no válido.
InvalidAdaptationMapping

Asignación de adaptación no válida.
InvalidDataset

Conjunto de datos no válido.
InvalidTest

Prueba no válida.
FailedDataset

Conjunto de datos con errores.
InvalidModel

Modelo no válido.
InvalidTranscription

Transcripción no válida.
InvalidPayload

Carga no válida.
InvalidParameter

Parámetro no válido.
EndpointWithoutLogging

Punto de conexión sin registro.
InvalidPermissions

Permisos no válidos.
InvalidPrerequisite

Requisito previo no válido.
InvalidProductId

Identificador de producto no válido.
InvalidSubscription

Suscripción no válida.
InvalidProject

Proyecto no válido.
InvalidProjectKind

Tipo de proyecto no válido.
InvalidRecordingsUri

URI de grabaciones no válidos.
OnlyOneOfUrlsOrContainerOrDataset

Solo una de direcciones URL o contenedor o conjunto de datos.
ExceededNumberOfRecordingsUris

Se superó el número de uris de grabaciones.
ModelMismatch

Error de coincidencia del modelo.
ProjectGenderMismatch

No coinciden los géneros del proyecto.
ModelDeprecated

Modelo en desuso.
ModelExists

El modelo existe.
ModelNotDeployable

El modelo no se puede implementar.
EndpointNotUpdatable

Punto de conexión no actualizable.
SingleDefaultEndpoint

Punto de conexión predeterminado único.
EndpointCannotBeDefault

El punto de conexión no puede ser predeterminado.
InvalidModelUri

URI de modelo no válido.
SubscriptionNotFound

No se encontró la suscripción.
QuotaViolation

Infracción de cuota.
UnsupportedDelta

Delta no admitido.
UnsupportedFilter

Filtro no admitido.
UnsupportedPagination

Paginación no admitida.
UnsupportedDynamicConfiguration

Configuración dinámica no admitida.
UnsupportedOrderBy

Orden no admitido por.
NoUtf8WithBom

No hay utf8 con bom.
ModelDeploymentNotCompleteState

La implementación del modelo no está completa.
SkuLimitsExist

Existen límites de SKU.
DeployingFailedModel

Se ha producido un error en la implementación del modelo.
UnsupportedTimeRange

Intervalo de tiempo no admitido.
InvalidLogDate

Fecha de registro no válida.
InvalidLogId

Identificador de registro no válido.
InvalidLogStartTime

Hora de inicio del registro no válida.
InvalidLogEndTime

Hora de finalización del registro no válida.
InvalidTopForLogs

Top no válido para los registros.
InvalidSkipTokenForLogs

Token de omisión no válido para los registros.
DeleteNotAllowed

Eliminar no permitido.
Forbidden

Prohibido.
DeployNotAllowed

No se permite la implementación.
UnexpectedError

Error inesperado.
InvalidCollection

Colección no válida.
InvalidCallbackUri

URI de devolución de llamada no válido.
InvalidSasValidityDuration

Duración de validez de sas no válida.
InaccessibleCustomerStorage

Almacenamiento de clientes inaccesible.
UnsupportedClassBasedAdaptation

Adaptación basada en clases no admitidas.
InvalidWebHookEventKind

Tipo de evento web hook no válido.
InvalidTimeToLive

Tiempo de vida no válido.
InvalidSourceAzureResourceId

Identificador de recurso de Azure de origen no válido.
ModelCopyOperationExists

Existe una operación de copia del modelo.

Endpoint

Object

Punto final

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).
customProperties

object

Propiedades personalizadas de esta entidad. La longitud máxima de clave permitida es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es de 10.
description

string

Descripción del objeto.
displayName

string

minLength: 1

Nombre para mostrar del objeto.
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).
links

EndpointLinks

EndpointLinks
locale

string

minLength: 1

Configuración regional de los datos contenidos.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string (uri)

Ubicación de esta entidad.
status

Status

Estado
Describir el estado actual de la API
text

string

Texto usado para adaptar un modelo de lenguaje para este punto de conexión.
Object

EndpointLinks

Nombre Tipo Description
logs

string (uri)

Registros de audio y transcripción para este punto de conexión. Consulte la operación "Endpoints_ListLogs" para obtener más información.
restConversation

string (uri)

Punto de conexión REST para solicitudes de hasta 60 segundos.
restDictation

string (uri)

Punto de conexión REST para solicitudes de hasta 60 segundos, lo que admite el dictado de signos de puntuación.
restInteractive

string (uri)

Punto de conexión REST para solicitudes cortas de hasta 15 segundos.
webSocketConversation

string (uri)

Punto de conexión del SDK de Voz para solicitudes largas con varios resultados finales.
webSocketDictation

string (uri)

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 (uri)

El punto de conexión del SDK de Voz para solicitudes cortas de hasta 15 segundos con un único resultado final.

EndpointProperties

Object

EndpointProperties

Nombre Tipo Description
email

string

La dirección de correo electrónico a la que enviar 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 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. No establecer este valor o establecer en 0 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

Object

EntityError

Nombre Tipo Description
code

string

Código de este error.
message

string

Mensaje para este error.

EntityReference

Object

EntityReference

Nombre Tipo Description
self

string (uri)

Ubicación de la entidad a la que se hace referencia.

Error

Object

Error

Nombre Tipo Description
code

ErrorCode

ErrorCode
Códigos de error de alto nivel.
details

Error[]

Detalles de apoyo adicionales 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án disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y propiedades opcionales de destino, details(key value pair), inner error(this can be nested).
message

string

Mensaje de error de alto nivel.
target

string

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

ErrorCode

Enumeración

ErrorCode

Valor Description
InvalidRequest

Representa el código de error de solicitud no válido.
InvalidArgument

Representa el código de error de argumento no válido.
InternalServerError

Representa el código de error interno del servidor.
ServiceUnavailable

Representa el código de error del servicio no disponible.
NotFound

Representa el código de error no encontrado.
PipelineError

Representa el código de error de canalización.
Conflict

Representa el código de error en conflicto.
InternalCommunicationFailed

Representa el código de error de comunicación interna con error.
Forbidden

Representa el código de error prohibido.
NotAllowed

Representa el código de error no permitido.
Unauthorized

Representa el código de error no autorizado.
UnsupportedMediaType

Representa el código de error de tipo de medio no admitido.
TooManyRequests

Representa el código de error de demasiadas solicitudes.
UnprocessableEntity

Representa el código de error de entidad no procesado.

InnerError

Object

InnerError

Nombre Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeración detallada del código de error.
details

object

Detalles de apoyo adicionales 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án disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y propiedades opcionales de destino, details(key value pair), inner error(this can be nested).
message

string

Mensaje de error de alto nivel.
target

string

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

PaginatedEndpoints

Object

PaginatedEndpoints

Nombre Tipo Description
@nextLink

string (uri)

Vínculo al siguiente conjunto de resultados paginados si hay más entidades disponibles; de lo contrario, null.
values

Endpoint[]

Lista de entidades limitadas por los parámetros de consulta pasados "skip" y "top" o sus valores predeterminados.

Al recorrer en iteración una lista mediante la paginación y la eliminación de entidades en paralelo, algunas entidades se omitirán en los resultados. Se recomienda crear una lista en el cliente y eliminar después de la captura de la lista completa.

Status

Enumeración

Estado

Valor Description
NotStarted

La operación de larga duración aún no se ha iniciado.
Running

La operación de larga duración se está procesando actualmente.
Succeeded

La operación de larga duración se ha completado correctamente.
Failed

Error en la operación de larga duración.