Endpoints - Create

Referência

Serviço:: Azure AI Services

Versão da API:: 3.2

Cria um novo ponto de extremidade.

POST {endpoint}/speechtotext/v3.2/endpoints

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

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
displayName	True	string	O nome para exibição do objeto.
locale	True	string	A localidade dos dados contidos.
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 .
model		EntityReference	EntityReference
project		EntityReference	EntityReference
properties		EndpointProperties	EndpointProperties
text		string	O texto usado para adaptar um modelo de linguagem para esse ponto de extremidade.

Respostas

Nome	Tipo	Description
201 Created	Endpoint	A resposta contém informações sobre a entidade como conteúdo e sua localização como cabeçalho. Cabeçalhos Location: string
Other Status Codes	Error	Ocorreu um erro.

Nome

Tipo

Description

201 Created

Endpoint

A resposta contém informações sobre a entidade como conteúdo e sua localização como cabeçalho.

Cabeçalhos

Location: string

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

Create an endpoint

Solicitação de exemplo

HTTP

POST {
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}/speechtotext/v3.2/endpoints

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}

Resposta de exemplo

Código de status:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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

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.
InvalidChannels	string	Canais inválidos.
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.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization expirado.
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 idioma 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 ("AAAA-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	O nome para exibição do objeto.
lastActionDateTime	string	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 ("AAAA-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. Confira 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

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 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 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

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

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

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 interno do servidor.
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 de serviço indisponível.
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

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

Nome	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á sendo processada no momento.
Succeeded	string	A operação de execução prolongada foi concluída com êxito.

Compartilhar via

Endpoints - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Create an endpoint

Solicitação de exemplo

Resposta de exemplo

Definições

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

Recursos adicionais