Evaluations - List

Referência

Serviço:: Azure AI Services

Versão da API:: v3.1

Obtém a lista de avaliações para a subscrição autenticada.

GET {endpoint}/speechtotext/v3.1/evaluations

Com parâmetros opcionais:

GET {endpoint}/speechtotext/v3.1/evaluations?skip={skip}&top={top}&filter={filter}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
filter	query		string	Uma expressão de filtragem para selecionar um subconjunto das avaliações disponíveis. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My evaluation'`
skip	query		integer (int32)	Número de conjuntos de dados que serão ignorados.
top	query		integer (int32)	Número de conjuntos de dados que serão incluídos após ignorar.

Respostas

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

Name

Tipo

Description

200 OK

PaginatedEvaluations

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT devolvido pelo STS desta região. Confirme que adiciona o âmbito de gestão ao token ao adicionar a seguinte cadeia de consulta ao URL de STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all evaluations

Get all evaluations with where status is equal to 'Running'

Get all evaluations

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/v3.1/evaluations?skip=0&top=2

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/a55a327b-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2"
}

Get all evaluations with where status is equal to 'Running'

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/v3.1/evaluations?skip=0&top=2&filter=status%20eq%20'Running'

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/f85a328c-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.98,
        "wordErrorRate1": 0.89,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    }
  ]
}

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Erro
ErrorCode	CódigoDoErro
Evaluation	Avaliação
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
InnerError	InnerError
PaginatedEvaluations	PaginatedEvaluations
Status	Estado

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	A eliminação não é permitida.
DeployNotAllowed	A implementação não é permitida.
DeployingFailedModel	A implementar o modelo com falhas.
EmptyRequest	Pedido Vazio.
EndpointCannotBeDefault	O ponto final não pode ser predefinido.
EndpointNotUpdatable	Ponto final não atualizável.
EndpointWithoutLogging	Ponto final sem registo.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
FailedDataset	Conjunto de dados com falha.
Forbidden	Proibido.
InUseViolation	Violação de utilização.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidBaseModel	Modelo base inválido.
InvalidCallbackUri	URI de chamada de retorno inválido.
InvalidCollection	Coleção inválida.
InvalidDataset	Conjunto de dados inválido.
InvalidDocument	Documento inválido.
InvalidDocumentBatch	Lote de Documentos inválido.
InvalidLocale	Região inválida.
InvalidLogDate	Data de registo inválida.
InvalidLogEndTime	Hora de fim de registo inválida.
InvalidLogId	ID de registo inválido.
InvalidLogStartTime	Hora de início de registo inválida.
InvalidModel	Modelo inválido.
InvalidModelUri	URI de modelo inválido.
InvalidParameter	Parâmetro inválido.
InvalidParameterValue	Valor de parâmetro inválido.
InvalidPayload	Payload inválido.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID de produto inválido.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
InvalidRequestBodyFormat	Formato do corpo do pedido inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de ignorar inválido para registos.
InvalidSubscription	Subscrição inválida.
InvalidTest	Teste inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidTopForLogs	Top inválido para registos.
InvalidTranscription	Transcrição inválida.
InvalidWebHookEventKind	Tipo de evento de web hook inválido.
MissingInputRecords	Registos de Entrada em Falta.
ModelDeploymentNotCompleteState	A implementação do modelo não está concluída.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelMismatch	Erro de correspondência do modelo.
ModelNotDeployable	Modelo não implementável.
ModelVersionIncorrect	Versão do Modelo Incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos URLs, contentor ou conjunto de dados.
ProjectGenderMismatch	Erro de correspondência de género do projeto.
QuotaViolation	Violação de quota.
SingleDefaultEndpoint	Ponto final predefinido único.
SkuLimitsExist	Existem limites de SKU.
SubscriptionNotFound	Subscrição não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classes não suportada.
UnsupportedDelta	Delta não suportado.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedFilter	Filtro não suportado.
UnsupportedLanguageCode	Código de idioma não suportado.
UnsupportedOrderBy	Encomenda não suportada por.
UnsupportedPagination	Paginação não suportada.
UnsupportedTimeRange	Intervalo de tempo não suportado.

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

Error

Object

Erro

Name	Tipo	Description
code	ErrorCode	CódigoDoErro Códigos de erro de alto nível.
details	Error[]	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto 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" em caso de documento inválido.

ErrorCode

Enumeração

CódigoDoErro

Valor	Description
Conflict	Representando o código de erro de conflito.
Forbidden	Representando o código de erro proibido.
InternalCommunicationFailed	A representação do código de erro de comunicação interna falhou.
InternalServerError	Representando o código de erro interno do servidor.
InvalidArgument	Representando o código de erro de argumento inválido.
InvalidRequest	Representando o código de erro de pedido inválido.
NotAllowed	Representando o código de erro não permitido.
NotFound	Representa o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
TooManyRequests	Representando o código de erro demasiados pedidos.
Unauthorized	Representa o código de erro não autorizado.
UnprocessableEntity	Representando o código de erro de entidade não processado.
UnsupportedMediaType	Representando o código de erro de tipo de suporte de dados não suportado.

Evaluation

Object

Avaliação

Name	Tipo	Description
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte 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 carateres, o comprimento máximo permitido do valor é de 256 carateres e a contagem de entradas permitidas é de 10.
dataset	EntityReference	EntityReference
description	string	A descrição do objeto.
displayName	string minLength: 1	O nome a apresentar do objeto.
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o estado atual foi introduzido. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EvaluationLinks	EvaluationLinks
locale	string minLength: 1	A região dos dados contidos.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string (uri)	A localização desta entidade.
status	Status	Estado Descrever o estado atual da API
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Object

EvaluationLinks

Name	Tipo	Description
files	string (uri)	A localização para obter todos os ficheiros desta entidade. Veja a operação "Evaluations_ListFiles" para obter mais detalhes.

EvaluationProperties

Object

EvaluationProperties

Name	Tipo	Description
correctWordCount1	integer (int32)	O número de palavras reconhecidas corretamente por model1.
correctWordCount2	integer (int32)	O número de palavras reconhecidas corretamente por model2.
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 depois de enviar o e-mail com êxito.
error	EntityError	EntityError
sentenceCount1	integer (int32)	O número de frases processadas por model1.
sentenceCount2	integer (int32)	O número de frases processadas por model2.
sentenceErrorRate1	number (double)	A taxa de erro de frase de reconhecimento com model1.
sentenceErrorRate2	number (double)	A taxa de erro de frase de reconhecimento com model2.
wordCount1	integer (int32)	O número de palavras processadas por model1.
wordCount2	integer (int32)	O número de palavras processadas por model2.
wordDeletionCount1	integer (int32)	O número de palavras reconhecidas por model1, que são eliminações.
wordDeletionCount2	integer (int32)	O número de palavras reconhecidas por model2, que são eliminações.
wordErrorRate1	number (double)	A palavra taxa de erro de reconhecimento com model1.
wordErrorRate2	number (double)	A palavra taxa de erro de reconhecimento com model2.
wordInsertionCount1	integer (int32)	O número de palavras reconhecidas por model1, que são inserções.
wordInsertionCount2	integer (int32)	O número de palavras reconhecidas por model2, que são inserções.
wordSubstitutionCount1	integer (int32)	O número de palavras reconhecidas por model1, que são substituições.
wordSubstitutionCount2	integer (int32)	O número de palavras reconhecidas por model2, que são substituições.

InnerError

Object

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enum de código de erro detalhado.
details	object	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto 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" em caso de documento inválido.

PaginatedEvaluations

Object

PaginatedEvaluations

Name	Tipo	Description
@nextLink	string (uri)	Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.
values	Evaluation[]	Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos. Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Name

Tipo

Description

@nextLink

string (uri)

Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.

values

Evaluation[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos.

Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Status

Enumeração

Estado

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

Partilhar via

Evaluations - List

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Get all evaluations

Pedido de amostra

Resposta da amostra

Get all evaluations with where status is equal to 'Running'

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

PaginatedEvaluations

Status

Recursos adicionais