Endpoints - List
Obtém a lista de pontos finais para a subscrição autenticada.
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip={skip}&top={top}&filter={filter}
Parâmetros do URI
Name | Em | Necessário | Tipo | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com). |
filter
|
query |
string |
Uma expressão de filtragem para selecionar um subconjunto dos pontos finais disponíveis.
|
|
skip
|
query |
integer int32 |
Número de conjuntos de dados que serão ignorados. |
|
top
|
query |
integer int32 |
Número de conjuntos de dados que serão incluídos após ignorar. |
Respostas
Name | Tipo | Description |
---|---|---|
200 OK |
OK Cabeçalhos Retry-After: integer |
|
Other Status Codes |
Ocorreu um erro. |
Segurança
Ocp-Apim-Subscription-Key
Forneça a chave da conta dos serviços cognitivos aqui.
Tipo:
apiKey
Em:
header
Authorization
Forneça um token de acesso do JWT devolvido pelo STS desta região. Certifique-se de que adiciona o âmbito de gestão ao token ao adicionar a seguinte cadeia de consulta ao URL de STS: ?scope=speechservicesmanagement
Tipo:
apiKey
Em:
header
Exemplos
Get all endpoints |
Get all queued endpoints. |
Get all endpoints
Pedido de amostra
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z
Resposta da amostra
{
"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.
Pedido de amostra
GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'
Resposta da amostra
{
"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"
}
]
}
Definições
Name | Description |
---|---|
Detailed |
DetailedErrorCode |
Endpoint |
Ponto final |
Endpoint |
EndpointLinks |
Endpoint |
EndpointProperties |
Entity |
EntityError |
Entity |
EntityReference |
Error |
Erro |
Error |
CódigoDoErro |
Inner |
InnerError |
Paginated |
PaginatedEndpoints |
Status |
Estado |
DetailedErrorCode
DetailedErrorCode
Name | Tipo | Description |
---|---|---|
DataImportFailed |
string |
Falha na importação de dados. |
DeleteNotAllowed |
string |
Eliminar não permitido. |
DeployNotAllowed |
string |
A implementação não é permitida. |
DeployingFailedModel |
string |
A implementação do modelo com falha. |
EmptyRequest |
string |
Pedido Vazio. |
EndpointCannotBeDefault |
string |
O ponto final não pode ser predefinido. |
EndpointNotUpdatable |
string |
O ponto final não é atualizável. |
EndpointWithoutLogging |
string |
Ponto final sem registo. |
ExceededNumberOfRecordingsUris |
string |
Número excedido de uris de gravações. |
FailedDataset |
string |
Conjunto de dados com falha. |
Forbidden |
string |
Proibido. |
InUseViolation |
string |
Violação de utilização. |
InaccessibleCustomerStorage |
string |
Armazenamento de clientes inacessível. |
InvalidAdaptationMapping |
string |
Mapeamento de adaptação inválido. |
InvalidBaseModel |
string |
Modelo base inválido. |
InvalidCallbackUri |
string |
URI de chamada de retorno inválido. |
InvalidCollection |
string |
Coleção inválida. |
InvalidDataset |
string |
Conjunto de dados inválido. |
InvalidDocument |
string |
Documento inválido. |
InvalidDocumentBatch |
string |
Lote de Documentos inválido. |
InvalidLocale |
string |
Região inválida. |
InvalidLogDate |
string |
Data de registo inválida. |
InvalidLogEndTime |
string |
Hora de fim do registo inválida. |
InvalidLogId |
string |
ID de registo inválido. |
InvalidLogStartTime |
string |
Hora de início do registo inválida. |
InvalidModel |
string |
Modelo inválido. |
InvalidModelUri |
string |
URI de modelo inválido. |
InvalidParameter |
string |
Parâmetro inválido. |
InvalidParameterValue |
string |
Valor de parâmetro inválido. |
InvalidPayload |
string |
Payload inválido. |
InvalidPermissions |
string |
Permissões inválidas. |
InvalidPrerequisite |
string |
Pré-requisito inválido. |
InvalidProductId |
string |
ID de produto inválido. |
InvalidProject |
string |
Projeto inválido. |
InvalidProjectKind |
string |
Tipo de projeto inválido. |
InvalidRecordingsUri |
string |
URI de gravações inválido. |
InvalidRequestBodyFormat |
string |
Formato do corpo do pedido inválido. |
InvalidSasValidityDuration |
string |
Duração de validade sas inválida. |
InvalidSkipTokenForLogs |
string |
Token de ignorar inválido para registos. |
InvalidSourceAzureResourceId |
string |
ID de recurso do Azure de origem inválido. |
InvalidSubscription |
string |
Subscrição inválida. |
InvalidTest |
string |
Teste inválido. |
InvalidTimeToLive |
string |
Tempo de vida inválido. |
InvalidTopForLogs |
string |
Top inválido para registos. |
InvalidTranscription |
string |
Transcrição inválida. |
InvalidWebHookEventKind |
string |
Tipo de evento de web hook inválido. |
MissingInputRecords |
string |
Registos de Entrada em Falta. |
ModelCopyOperationExists |
string |
A operação de cópia de modelo existe. |
ModelDeploymentNotCompleteState |
string |
A implementação do modelo não está concluída. |
ModelDeprecated |
string |
Modelo preterido. |
ModelExists |
string |
O modelo existe. |
ModelMismatch |
string |
Erro de correspondência do modelo. |
ModelNotDeployable |
string |
Modelo não implementável. |
ModelVersionIncorrect |
string |
Versão do Modelo Incorreta. |
NoUtf8WithBom |
string |
Não utf8 com bom. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Apenas um dos URLs, contentor ou conjunto de dados. |
ProjectGenderMismatch |
string |
Erro de correspondência de género do projeto. |
QuotaViolation |
string |
Violação de quota. |
SingleDefaultEndpoint |
string |
Ponto final predefinido único. |
SkuLimitsExist |
string |
Existem limites de SKU. |
SubscriptionNotFound |
string |
Subscrição não encontrada. |
UnexpectedError |
string |
Erro inesperado. |
UnsupportedClassBasedAdaptation |
string |
Adaptação baseada em classes não suportada. |
UnsupportedDelta |
string |
Delta não suportado. |
UnsupportedDynamicConfiguration |
string |
Configuração dinâmica não suportada. |
UnsupportedFilter |
string |
Filtro não suportado. |
UnsupportedLanguageCode |
string |
Código de idioma não suportado. |
UnsupportedOrderBy |
string |
Encomenda não suportada por. |
UnsupportedPagination |
string |
Paginação não suportada. |
UnsupportedTimeRange |
string |
Intervalo de tempo não suportado. |
Endpoint
Ponto final
Name | Tipo | Description |
---|---|---|
createdDateTime |
string |
O carimbo de data/hora quando o objeto foi criado. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
customProperties |
object |
As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 carateres, o comprimento máximo permitido do valor é de 256 carateres e a contagem de entradas permitidas é de 10. |
description |
string |
A descrição do objeto. |
displayName |
string |
O nome a apresentar do objeto. |
lastActionDateTime |
string |
O carimbo de data/hora quando o estado atual foi introduzido. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). |
links |
EndpointLinks |
|
locale |
string |
A região dos dados contidos. |
model |
EntityReference |
|
project |
EntityReference |
|
properties |
EndpointProperties |
|
self |
string |
A localização desta entidade. |
status |
Estado |
|
text |
string |
O texto utilizado para adaptar um modelo de idioma para este ponto final. |
EndpointLinks
EndpointLinks
Name | Tipo | Description |
---|---|---|
logs |
string |
Os registos de áudio e transcrição deste ponto final. Veja a operação "Endpoints_ListLogs" para obter mais detalhes. |
restConversation |
string |
O ponto final REST para pedidos até 60 segundos. |
restDictation |
string |
O ponto final REST para pedidos até 60 segundos, suportando o ditado das marcas de pontuação. |
restInteractive |
string |
O ponto final REST para pedidos curtos até 15 segundos. |
webSocketConversation |
string |
O ponto final do SDK de Voz para pedidos longos com múltiplos resultados finais. |
webSocketDictation |
string |
O ponto final do SDK de Voz para pedidos longos com múltiplos resultados finais, suportando o ditado das marcas de pontuação. |
webSocketInteractive |
string |
O ponto final do SDK de Voz para pedidos curtos até 15 segundos com um único resultado final. |
EndpointProperties
EndpointProperties
Name | Tipo | Description |
---|---|---|
string |
O endereço de e-mail para o qual enviar notificações por e-mail, caso a operação seja concluída. O valor será removido depois de enviar o e-mail com êxito. |
|
error |
EntityError |
|
loggingEnabled |
boolean |
Um valor que indica se o registo de conteúdos (transcrições de áudio &) está a ser utilizado para uma implementação. |
timeToLive |
string |
Durante quanto tempo o ponto final será mantido no sistema. Assim que o ponto final atingir o tempo de vida após a conclusão (com êxito ou com falha), será eliminado automaticamente. Não definir este valor ou definição como 0 irá desativar a eliminação automática. A duração suportada mais longa é de 31 dias. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", consulte https://en.wikipedia.org/wiki/ISO_8601#Durations). |
EntityError
EntityError
Name | Tipo | Description |
---|---|---|
code |
string |
O código deste erro. |
message |
string |
A mensagem para este erro. |
EntityReference
EntityReference
Name | Tipo | Description |
---|---|---|
self |
string |
A localização da entidade referenciada. |
Error
Erro
Name | Tipo | Description |
---|---|---|
code |
CódigoDoErro |
|
details |
Error[] |
Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensagem de erro de alto nível. |
target |
string |
A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido. |
ErrorCode
CódigoDoErro
Name | Tipo | Description |
---|---|---|
Conflict |
string |
Representando o código de erro de conflito. |
Forbidden |
string |
Representando o código de erro proibido. |
InternalCommunicationFailed |
string |
A representação do código de erro de comunicação interna falhou. |
InternalServerError |
string |
Representando o código de erro interno do servidor. |
InvalidArgument |
string |
Representando o código de erro de argumento inválido. |
InvalidRequest |
string |
Representando o código de erro de pedido inválido. |
NotAllowed |
string |
Representando o código de erro não permitido. |
NotFound |
string |
Representa o código de erro não encontrado. |
PipelineError |
string |
Representando o código de erro do pipeline. |
ServiceUnavailable |
string |
Representando o código de erro indisponível do serviço. |
TooManyRequests |
string |
Representando o código de erro demasiados pedidos. |
Unauthorized |
string |
Representa o código de erro não autorizado. |
UnprocessableEntity |
string |
Representando o código de erro de entidade não processado. |
UnsupportedMediaType |
string |
Representando o código de erro de tipo de suporte de dados não suportado. |
InnerError
InnerError
Name | Tipo | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensagem de erro de alto nível. |
target |
string |
A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido. |
PaginatedEndpoints
PaginatedEndpoints
Name | Tipo | Description |
---|---|---|
@nextLink |
string |
Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo. |
values |
Endpoint[] |
Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos. Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa. |
Status
Estado
Name | Tipo | Description |
---|---|---|
Failed |
string |
A operação de execução prolongada falhou. |
NotStarted |
string |
A operação de execução prolongada ainda não foi iniciada. |
Running |
string |
A operação de execução prolongada está atualmente a ser processada. |
Succeeded |
string |
A operação de execução prolongada foi concluída com êxito. |