Endpoints - Update

Serviço:: Azure AI Services

Versão da API:: v3.2-preview.2

Atualiza os metadados do ponto de extremidade identificado pelo ID fornecido.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	O identificador do ponto de extremidade.

Corpo do Pedido

Media Types: "application/json", "application/merge-patch+json"

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta 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 do objeto.
model	EntityReference	EntidadeReferência
project	EntityReference	EntidadeReferência
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

Respostas

Name	Tipo	Description
200 OK	Endpoint	OK Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

200 OK

Endpoint

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da sua 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. Certifique-se de adicionar o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Update an endpoint

Pedido de amostra

HTTP

PATCH {endpoint}/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/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "properties": {
    "contentLoggingEnabled": true
  },
  "displayName": "Updated endpoint with new model",
  "customProperties": {
    "key": "value"
  }
}

Resposta da amostra

Código de estado:: 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

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Ponto final
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EndpointPropertiesUpdate	EndpointPropertiesUpdate
EndpointUpdate	EndpointUpdate
EntityError	EntityError
EntityReference	EntidadeReferência
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 de corpo de solicitação inválido.
EmptyRequest	Pedido vazio.
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 não suportado.
DataImportFailed	Falha na importação de dados.
InUseViolation	Violação em 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	Carga útil inválida.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidSubscription	Subscrição inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
ModelMismatch	Incompatibilidade de modelos.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto final 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	Subscrição não encontrada.
QuotaViolation	Violação de quotas.
UnsupportedDelta	Delta não suportado.
UnsupportedFilter	Filtro não suportado.
UnsupportedPagination	Paginação não suportada.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedOrderBy	Ordem não suportada por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
SkuLimitsExist	Existem limites de Sku.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo não suportado.
InvalidLogDate	Data de registo inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de log inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
DeleteNotAllowed	Excluir não permitido.
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 inacessível do cliente.
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 do modelo existe.

Endpoint

Object

Ponto final

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver 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 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 minLength: 1	O nome para 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 ("AAAA-MM-DDThh:mm:ssZ", ver 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	EntidadeReferência
project	EntityReference	EntidadeReferência
properties	EndpointProperties	EndpointProperties
self	string (uri)	A localização desta entidade.
status	Status	Situação Descrever o estado atual da API
text	string	O texto usado para adaptar um modelo de linguagem para este ponto de extremidade.

EndpointLinks

Object

EndpointLinks

Name	Tipo	Description
logs	string (uri)	Os logs de áudio e transcrição para este 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, suportando ditado de sinais 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, suportando o ditado de sinais 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

Object

EndpointProperties

Name	Tipo	Description
email	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 após o envio bem-sucedido do e-mail.
error	EntityError	EntityError
loggingEnabled	boolean	Um valor que indica se o log de conteúdo (transcrições de áudio & áudio) está sendo usado para uma implantação.
timeToLive	string	Por quanto tempo o endpoint será mantido no sistema. Quando o endpoint atingir o tempo de vida após a conclusão (bem-sucedido ou reprovado), ele será automaticamente excluído. Não definir esse valor ou definir como 0 desativará a exclusão automática. A duração suportada mais longa é de 31 dias. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", ver https://en.wikipedia.org/wiki/ISO_8601#Durations).

EndpointPropertiesUpdate

Object

EndpointPropertiesUpdate

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

EndpointUpdate

Object

EndpointUpdate

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta 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 do objeto.
model	EntityReference	EntidadeReferência
project	EntityReference	EntidadeReferência
properties	EndpointPropertiesUpdate	EndpointPropertiesUpdate

EntityError

Object

EntityError

Name	Tipo	Description
code	string	O código deste erro.
message	string	A mensagem para este erro.

EntityReference

Object

EntidadeReferência

Name	Tipo	Description
self	string (uri)	A localização da entidade referenciada.

Error

Object

Erro

Name	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 políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no 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álida.
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 não suportado.
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

Object

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Código de erro detalhado enum.
details	object	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

Status

Enumeração

Situação

Valor	Description
NotStarted	A operação de longa duração ainda não começou.
Running	A operação de longa duração está atualmente em processamento.
Succeeded	A operação de longa duração foi concluída com êxito.
Failed	A operação de longa duração falhou.