Compartilhar via

Endpoints - Get

  • Referência
Serviço:
Azure AI Services
Versão da API:
v3.2-preview.2

Obtém o ponto de extremidade identificado pela ID fornecida.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
endpoint
 path True

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id
 path True

string

uuid

O identificador do ponto de extremidade.

Respostas

Nome Tipo Description
200 OK

Endpoint

OK

Cabeçalhos

Retry-After: integer
Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça sua chave de conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS dessa região. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get an endpoint

Solicitação de exemplo

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

Resposta de exemplo

Código de status:
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"
}

Definições

Nome Description
DetailedErrorCode

DetailedErrorCode
Endpoint

Ponto de extremidade
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EntityError

EntityError
EntityReference

EntityReference
Error

Erro
ErrorCode

ErrorCode
InnerError

InnerError
Status

Status

DetailedErrorCode

DetailedErrorCode

Nome Tipo Description
DataImportFailed

string

Falha na importação de dados.
DeleteNotAllowed

string

Excluir não é permitido.
DeployNotAllowed

string

Implantação não permitida.
DeployingFailedModel

string

Implantação de modelo com falha.
EmptyRequest

string

Solicitação vazia.
EndpointCannotBeDefault

string

O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable

string

Ponto de extremidade não atualizável.
EndpointWithoutLogging

string

Ponto de extremidade sem registro em log.
ExceededNumberOfRecordingsUris

string

Número excedido de uris de gravações.
FailedDataset

string

Conjunto de dados com falha.
Forbidden

string

Negado.
InUseViolation

string

Violação de uso.
InaccessibleCustomerStorage

string

Armazenamento inacessível do cliente.
InvalidAdaptationMapping

string

Mapeamento de adaptação inválido.
InvalidBaseModel

string

Modelo base inválido.
InvalidCallbackUri

string

URI de retorno de chamada 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

Localidade inválida.
InvalidLogDate

string

Data de log inválida.
InvalidLogEndTime

string

Hora de término do log inválida.
InvalidLogId

string

ID de log inválida.
InvalidLogStartTime

string

Hora de início do log 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

Conteúdo inválido.
InvalidPermissions

string

Permissões inválidas.
InvalidPrerequisite

string

Pré-requisito inválido.
InvalidProductId

string

ID do produto inválida.
InvalidProject

string

Projeto inválido.
InvalidProjectKind

string

Tipo de projeto inválido.
InvalidRecordingsUri

string

URI de gravações inválidas.
InvalidRequestBodyFormat

string

Formato do corpo da solicitação inválido.
InvalidSasValidityDuration

string

Duração de validade sas inválida.
InvalidSkipTokenForLogs

string

Token de ignorar inválido para logs.
InvalidSourceAzureResourceId

string

ID de recurso do Azure de origem inválida.
InvalidSubscription

string

Assinatura inválida.
InvalidTest

string

Teste inválido.
InvalidTimeToLive

string

Tempo de vida inválido.
InvalidTopForLogs

string

Parte superior inválida para logs.
InvalidTranscription

string

Transcrição inválida.
InvalidWebHookEventKind

string

Tipo de evento de gancho da Web inválido.
MissingInputRecords

string

Registros de entrada ausentes.
ModelCopyOperationExists

string

A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState

string

O estado de implantação do modelo não é concluído.
ModelDeprecated

string

Modelo preterido.
ModelExists

string

O modelo existe.
ModelMismatch

string

Incompatibilidade de modelo.
ModelNotDeployable

string

Modelo não implantável.
ModelVersionIncorrect

string

Versão do modelo incorreta.
NoUtf8WithBom

string

Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Apenas uma das URLs, contêiner ou conjunto de dados.
ProjectGenderMismatch

string

Incompatibilidade de gênero do projeto.
QuotaViolation

string

Violação de cota.
SingleDefaultEndpoint

string

Ponto de extremidade padrão único.
SkuLimitsExist

string

Existem limites de SKU.
SubscriptionNotFound

string

Assinatura não encontrada.
UnexpectedError

string

Erro inesperado.
UnsupportedClassBasedAdaptation

string

Adaptação baseada em classe sem suporte.
UnsupportedDelta

string

Delta sem suporte.
UnsupportedDynamicConfiguration

string

Configuração dinâmica sem suporte.
UnsupportedFilter

string

Filtro sem suporte.
UnsupportedLanguageCode

string

Código de linguagem sem suporte.
UnsupportedOrderBy

string

Ordem sem suporte por.
UnsupportedPagination

string

Paginação sem suporte.
UnsupportedTimeRange

string

Intervalo de tempo sem suporte.

Endpoint

Ponto de extremidade

Nome Tipo Description
createdDateTime

string

O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description

string

A descrição do objeto .
displayName

string

O nome para exibição do objeto.
lastActionDateTime

string

O carimbo de data/hora em que a status atual foi inserida. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

EndpointLinks

EndpointLinks
locale

string

A localidade dos dados contidos.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string

O local dessa entidade.
status

Status

Status
Descrever o estado atual da API
text

string

O texto usado para adaptar um modelo de linguagem para esse ponto de extremidade.

EndpointLinks

Nome Tipo Description
logs

string

Os logs de áudio e transcrição para esse ponto de extremidade. Consulte a operação "Endpoints_ListLogs" para obter mais detalhes.
restConversation

string

O ponto de extremidade REST para solicitações de até 60 segundos.
restDictation

string

O ponto de extremidade REST para solicitações de até 60 segundos, dando suporte ao ditado de marcas de pontuação.
restInteractive

string

O ponto de extremidade REST para solicitações curtas de até 15 segundos.
webSocketConversation

string

O ponto de extremidade do SDK de Fala para solicitações longas com vários resultados finais.
webSocketDictation

string

O ponto de extremidade do SDK de Fala para solicitações longas com vários resultados finais, dando suporte ao ditado de marcas de pontuação.
webSocketInteractive

string

O ponto de extremidade do SDK de Fala para solicitações curtas de até 15 segundos com um único resultado final.

EndpointProperties

EndpointProperties

Nome Tipo Description
email

string

O endereço de email para o qual enviar notificações por email caso a operação seja concluída. O valor será removido após o envio com êxito do email.
error

EntityError

EntityError
loggingEnabled

boolean

Um valor que indica se o log de conteúdo (transcrições de áudio &) está sendo usado para uma implantação.
timeToLive

string

Por quanto tempo o ponto de extremidade será mantido no sistema. Depois que o ponto de extremidade atingir o tempo de vida após a conclusão (bem-sucedido ou com falha), ele será excluído automaticamente. Não definir esse valor ou definir como 0 desabilitará a exclusão automática. A duração mais longa com suporte é de 31 dias. A duração é codificada como duração iso 8601 ("PnYnMnDTnHnMnS", consulte https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

EntityError

Nome Tipo Description
code

string

O código desse erro.
message

string

A mensagem para esse erro.

EntityReference

EntityReference

Nome Tipo Description
self

string

O local da entidade referenciada.

Error

Erro

Nome Tipo Description
code

ErrorCode

ErrorCode
Códigos de erro de alto nível.
details

Error[]

Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

ErrorCode

ErrorCode

Nome Tipo Description
Conflict

string

Representando o código de erro de conflito.
Forbidden

string

Representando o código de erro proibido.
InternalCommunicationFailed

string

Representando o código de erro de falha de comunicação interna.
InternalServerError

string

Representando o código de erro do servidor interno.
InvalidArgument

string

Representando o código de erro de argumento inválido.
InvalidRequest

string

Representando o código de erro de solicitação inválido.
NotAllowed

string

Representando o código de erro não permitido.
NotFound

string

Representando 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 de muitas solicitações.
Unauthorized

string

Representando o código de erro não autorizado.
UnprocessableEntity

string

Representando o código de erro de entidade não processável.
UnsupportedMediaType

string

Representando o código de erro de tipo de mídia sem suporte.

InnerError

InnerError

Nome Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração de código de erro detalhada.
details

object

Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

Status

Status

Nome Tipo Description
Failed

string

Falha na operação de execução prolongada.
NotStarted

string

A operação de execução prolongada ainda não foi iniciada.
Running

string

A operação de execução prolongada está sendo processada no momento.
Succeeded

string

A operação de execução prolongada foi concluída com êxito.