Evaluations - Update

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-15

Atualiza os detalhes mutáveis da avaliação identificada por sua ID.

PATCH {endpoint}/speechtotext/evaluations/{id}?api-version=2024-11-15

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 da avaliação.
api-version	query	True	string	A versão da API solicitada.

Cabeçalho da solicitação

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

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a chave da conta de serviços cognitivos aqui.

Corpo da solicitação

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

Nome	Tipo	Description
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 do objeto.

Respostas

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

Nome

Tipo

Description

200 OK

Evaluation

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

Exemplos

Update a evaluation

Solicitação de exemplo

HTTP

PATCH {endpoint}/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-11-15


{
  "displayName": "Updated evaluation",
  "description": "Updated evaluation description"
}

Resposta de exemplo

Código de status:: 200

{
  "displayName": "Evalution of one model against another model",
  "description": "The description of the evaluation",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6?api-version=2024-11-15",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f?api-version=2024-11-15"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/evaluations/00000000-0000-0000-0000-000000000000/files?api-version=2024-11-15"
  },
  "locale": "en-US",
  "properties": {
    "wordErrorRate1": 0.065,
    "sentenceErrorRate1": 0.375,
    "tokenErrorRate1": 0.125,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0,
    "tokenErrors1": {
      "punctuation": {
        "numberOfEdits": 2,
        "percentageOfAllEdits": 0.66
      },
      "capitalization": {
        "numberOfEdits": 1,
        "percentageOfAllEdits": 0.33
      }
    },
    "wordErrorRate2": 0.065,
    "sentenceErrorRate2": 0.375,
    "tokenErrorRate2": 0.125,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenErrors2": {
      "punctuation": {
        "numberOfEdits": 208,
        "percentageOfAllEdits": 1.22
      },
      "capitalization": {
        "numberOfEdits": 126,
        "percentageOfAllEdits": 0.74
      },
      "inverseTextNormalization": {
        "numberOfEdits": 409,
        "percentageOfAllEdits": 2.4
      },
      "lexical": {
        "numberOfEdits": 16284,
        "percentageOfAllEdits": 95.41
      },
      "others": {
        "numberOfEdits": 41,
        "percentageOfAllEdits": 0.24
      }
    }
  },
  "status": "Succeeded"
}

Definições

Nome	Description
DetailedErrorCode	DetailedErrorCode
EditsSummary	EditsSummary
EntityError	EntityError
EntityReference	EntityReference
Error	Erro
ErrorCode	ErrorCode
Evaluation	Avaliação
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
EvaluationUpdate	EvaluationUpdate
InnerError	InnerError
Status	Estado
TokenErrorDetails	TokenErrorDetails

DetailedErrorCode

Nome	Tipo	Description
AudioLengthLimitExceeded	string	O arquivo de áudio é maior que a duração máxima permitida.
BadChannelConfiguration	string	Há uma incompatibilidade entre canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	Exclusão não permitida.
DeployNotAllowed	string	Implantação não permitida.
DeployingFailedModel	string	Implantação de modelo com falha.
EmptyAudioFile	string	O arquivo de áudio está vazio.
EmptyRequest	string	Solicitação vazia.
EndpointCannotBeDefault	string	O ponto de extremidade não pode ser padrão.
EndpointLoggingNotSupported	string	Não há suporte para o registro em log do ponto de extremidade.
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	Proibido.
InUseViolation	string	Em violação de uso.
InaccessibleCustomerStorage	string	Armazenamento de clientes inacessível.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidAudioFormat	string	Não há suporte para o formato de áudio de entrada.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	URI de retorno de chamada inválido.
InvalidChannelSpecification	string	Não há suporte para a seleção de canais na solicitação de transcrição (por exemplo, nem 0 nem 1 foram selecionados).)
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á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 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	Implantação de modelo não completa o estado.
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.
MultipleLanguagesIdentified	string	Identificação de Idiomas reconheceu vários idiomas. Nenhuma linguagem dominante poderia ser determinada.
NoLanguageIdentified	string	A Identificação de Idiomas não reconheceu nenhum idioma.
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.

EditsSummary

Nome	Tipo	Description
numberOfEdits	integer	O número opcional de edições para um determinado tipo de erro da transcrição reconhecida em comparação com a transcrição humana.
percentageOfAllEdits	number	O percentual opcional de edições para um determinado tipo de erro da transcrição reconhecida em comparação com a transcrição humana.

EntityError

Nome	Tipo	Description
code	string	O código desse erro.
message	string	A mensagem para este 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. 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

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

Evaluation

Avaliação

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 de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
dataset	EntityReference	EntityReference
description	string	A descrição do objeto.
displayName	string	O nome de 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 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EvaluationLinks	EvaluationLinks
locale	string	A localidade dos dados contidos.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string	O local dessa entidade.
status	Status	Estado Descreva o estado atual da API.
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Nome	Tipo	Description
files	string	O local para obter todos os arquivos dessa entidade. Consulte a operação "Evaluations_ListFiles" para obter mais detalhes.

EvaluationProperties

Nome	Tipo	Description
correctTokenCount1	integer	O número opcional de tokens reconhecidos corretamente por model1.
correctTokenCount2	integer	O número opcional de tokens reconhecidos corretamente por model2.
correctWordCount1	integer	O número de palavras reconhecidas corretamente pelo model1.
correctWordCount2	integer	O número de palavras reconhecidas corretamente por model2.
error	EntityError	EntityError
sentenceCount1	integer	O número de sentenças processadas por model1.
sentenceCount2	integer	O número de sentenças processadas por model2.
sentenceErrorRate1	number	A taxa de erro de sentença de reconhecimento com model1.
sentenceErrorRate2	number	A taxa de erro de sentença de reconhecimento com model2.
tokenCount1	integer	O número opcional de tokens processados por model1.
tokenCount2	integer	O número opcional de tokens processados por model2.
tokenDeletionCount1	integer	O número opcional de tokens reconhecidos por model1, que são exclusões.
tokenDeletionCount2	integer	O número opcional de tokens reconhecidos por model2, que são exclusões.
tokenErrorRate1	number	A taxa de erro de token opcional de reconhecimento com model1.
tokenErrorRate2	number	A taxa de erro de token opcional de reconhecimento com model2.
tokenErrors1	TokenErrorDetails	TokenErrorDetails
tokenErrors2	TokenErrorDetails	TokenErrorDetails
tokenInsertionCount1	integer	O número opcional de tokens reconhecidos por model1, que são inserções.
tokenInsertionCount2	integer	O número opcional de tokens reconhecidos por model2, que são inserções.
tokenSubstitutionCount1	integer	O número opcional de tokens reconhecidos por model1, que são substituições.
tokenSubstitutionCount2	integer	O número opcional de tokens reconhecidos por model2, que são substituições.
wordCount1	integer	O número de palavras processadas por model1.
wordCount2	integer	O número de palavras processadas por model2.
wordDeletionCount1	integer	O número de palavras reconhecidas por model1, que são exclusões.
wordDeletionCount2	integer	O número de palavras reconhecidas por model2, que são exclusões.
wordErrorRate1	number	A taxa de erro de palavra de reconhecimento com model1.
wordErrorRate2	number	A taxa de erro de palavra de reconhecimento com model2.
wordInsertionCount1	integer	O número de palavras reconhecidas por model1, que são inserções.
wordInsertionCount2	integer	O número de palavras reconhecidas por model2, que são inserções.
wordSubstitutionCount1	integer	O número de palavras reconhecidas por model1, que são substituições.
wordSubstitutionCount2	integer	O número de palavras reconhecidas por model2, que são substituições.

EvaluationUpdate

Nome	Tipo	Description
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 do 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

Estado

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

TokenErrorDetails

Nome	Tipo	Description
capitalization	EditsSummary	EditsSummary
inverseTextNormalization	EditsSummary	EditsSummary
lexical	EditsSummary	EditsSummary
others	EditsSummary	EditsSummary
punctuation	EditsSummary	EditsSummary

Compartilhar via

Evaluations - Update

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Update a evaluation

Solicitação de exemplo

Resposta de exemplo

Definições

DetailedErrorCode

EditsSummary

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

EvaluationUpdate

InnerError

Status

TokenErrorDetails

Recursos adicionais