Endpoints - Get

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	OKEY Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Nome

Tipo

Description

200 OK

Endpoint

OKEY

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta 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

HTTP

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	Código de Erro
InnerError	InnerError
Status	Situação

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
EmptyRequest	Solicitação vazia.
MissingInputRecords	Registros de entrada ausentes.
InvalidDocument	Documento inválido.
ModelVersionIncorrect	Versão do modelo incorreta.
InvalidDocumentBatch	Lote de Documentos Inválido.
UnsupportedLanguageCode	Código de idioma sem suporte.
DataImportFailed	Falha na importação de dados.
InUseViolation	Em violação de uso.
InvalidLocale	Localidade inválida.
InvalidBaseModel	Modelo base inválido.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidDataset	Conjunto de dados inválido.
InvalidTest	Teste inválido.
FailedDataset	Conjunto de dados com falha.
InvalidModel	Modelo inválido.
InvalidTranscription	Transcrição inválida.
InvalidPayload	Conteúdo inválido.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidSubscription	Assinatura inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
ModelMismatch	Incompatibilidade de modelo.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
InvalidModelUri	URI de modelo inválido.
SubscriptionNotFound	Assinatura não encontrada.
QuotaViolation	Violação de cota.
UnsupportedDelta	Delta sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedPagination	Paginação sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
SkuLimitsExist	Existem limites de SKU.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo sem suporte.
InvalidLogDate	Data de log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
DeleteNotAllowed	Exclusão não permitida.
Forbidden	Proibido.
DeployNotAllowed	Implantação não permitida.
UnexpectedError	Erro inesperado.
InvalidCollection	Coleção inválida.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InaccessibleCustomerStorage	Armazenamento de clientes inacessível.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
ModelCopyOperationExists	A operação de cópia de modelo existe.

Endpoint

Objeto

Ponto de extremidade

Nome	Tipo	Description
createdDateTime	string (date-time)	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 de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
description	string	A descrição do objeto.
displayName	string minLength: 1	O nome de exibição do objeto.
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. 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 minLength: 1	A localidade dos dados contidos.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	O local dessa entidade.
status	Status	Situação Descrever o estado atual da API
text	string	O texto usado para adaptar um modelo de linguagem para esse ponto de extremidade.

EndpointLinks

Objeto

EndpointLinks

Nome	Tipo	Description
logs	string (uri)	Os logs de áudio e transcrição para esse ponto de extremidade. Consulte a operação "Endpoints_ListLogs" para obter mais detalhes.
restConversation	string (uri)	O ponto de extremidade REST para solicitações de até 60 segundos.
restDictation	string (uri)	O ponto de extremidade REST para solicitações de até 60 segundos, dando suporte ao ditado de marcas de pontuação.
restInteractive	string (uri)	O ponto de extremidade REST para solicitações curtas de até 15 segundos.
webSocketConversation	string (uri)	O ponto de extremidade do SDK de Fala para solicitações longas com vários resultados finais.
webSocketDictation	string (uri)	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 (uri)	O ponto de extremidade do SDK de Fala para solicitações curtas de até 15 segundos com um único resultado final.

EndpointProperties

Objeto

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 depois de enviar o email com êxito.
error	EntityError	EntityError
loggingEnabled	boolean	Um valor que indica se o registro em log de conteúdo (transcrições de & 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 útil 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

Objeto

EntityError

Nome	Tipo	Description
code	string	O código desse erro.
message	string	A mensagem para este erro.

EntityReference

Objeto

EntityReference

Nome	Tipo	Description
self	string (uri)	O local da entidade referenciada.

Error

Objeto

Erro

Nome	Tipo	Description
code	ErrorCode	Código de Erro 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. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Enumeração

Código de Erro

Valor	Description
InvalidRequest	Representando o código de erro de solicitação inválido.
InvalidArgument	Representando o código de erro de argumento inválido.
InternalServerError	Representando o código de erro interno do servidor.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
Conflict	Representando o código de erro de conflito.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
Forbidden	Representando o código de erro proibido.
NotAllowed	Representando o código de erro não permitido.
Unauthorized	Representando o código de erro não autorizado.
UnsupportedMediaType	Representando o código de erro de tipo de mídia sem suporte.
TooManyRequests	Representando o código de erro de muitas solicitações.
UnprocessableEntity	Representando o código de erro de entidade não processável.

InnerError

Objeto

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração detalhada do código de erro.
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. Isso contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valor de chave), erro interno(isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seriam "documentos" ou "id de documento" em caso de documento inválido.

Status

Enumeração

Situação

Valor	Description
NotStarted	A operação de execução prolongada ainda não foi iniciada.
Running	A operação de execução longa está sendo processada no momento.
Succeeded	A operação de execução longa foi concluída com êxito.
Failed	A operação de execução prolongada falhou.