Projects - List Evaluations

Referência

Serviço:: Azure AI Services

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

Obtém a lista de avaliações para o projeto especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/evaluations

Com parâmetros opcionais:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/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).
id	path	True	string uuid	O identificador do projeto.
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 chave da 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. Certifique-se de 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

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations?skip=0&top=2

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/a55a327b-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/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,
        "tokenErrorRate2": 0.125,
        "tokenErrorRate1": 0.125,
        "tokenCount2": 48,
        "correctTokenCount2": 42,
        "tokenSubstitutionCount2": 6,
        "tokenDeletionCount2": 0,
        "tokenInsertionCount2": 0,
        "tokenCount1": 48,
        "correctTokenCount1": 42,
        "tokenSubstitutionCount1": 6,
        "tokenDeletionCount1": 0,
        "tokenInsertionCount1": 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.2-preview.2/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/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,
        "tokenErrorRate2": 0.125,
        "tokenErrorRate1": 0.125,
        "tokenCount2": 48,
        "correctTokenCount2": 42,
        "tokenSubstitutionCount2": 6,
        "tokenDeletionCount2": 0,
        "tokenInsertionCount2": 0,
        "tokenCount1": 48,
        "correctTokenCount1": 42,
        "tokenSubstitutionCount1": 6,
        "tokenDeletionCount1": 0,
        "tokenInsertionCount1": 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.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?skip=2&top=2"
}

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

Name	Tipo	Description
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	Eliminar não permitido.
DeployNotAllowed	string	A implementação não é permitida.
DeployingFailedModel	string	A implementação do modelo com falha.
EmptyRequest	string	Pedido Vazio.
EndpointCannotBeDefault	string	O ponto final não pode ser predefinido.
EndpointNotUpdatable	string	O ponto final não é atualizável.
EndpointWithoutLogging	string	Ponto final sem registo.
ExceededNumberOfRecordingsUris	string	Número excedido de uris de gravações.
FailedDataset	string	Conjunto de dados com falha.
Forbidden	string	Proibido.
InUseViolation	string	Violação de utilização.
InaccessibleCustomerStorage	string	Armazenamento de clientes inacessível.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	URI de chamada de retorno inválido.
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	Região inválida.
InvalidLogDate	string	Data de registo inválida.
InvalidLogEndTime	string	Hora de fim do registo inválida.
InvalidLogId	string	ID de registo inválido.
InvalidLogStartTime	string	Hora de início do registo 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	Payload inválido.
InvalidPermissions	string	Permissões inválidas.
InvalidPrerequisite	string	Pré-requisito inválido.
InvalidProductId	string	ID de 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 do pedido inválido.
InvalidSasValidityDuration	string	Duração de validade sas inválida.
InvalidSkipTokenForLogs	string	Token de ignorar inválido para registos.
InvalidSourceAzureResourceId	string	ID de recurso do Azure de origem inválido.
InvalidSubscription	string	Subscrição inválida.
InvalidTest	string	Teste inválido.
InvalidTimeToLive	string	Tempo de vida inválido.
InvalidTopForLogs	string	Top inválido para registos.
InvalidTranscription	string	Transcrição inválida.
InvalidWebHookEventKind	string	Tipo de evento de web hook inválido.
MissingInputRecords	string	Registos de Entrada em Falta.
ModelCopyOperationExists	string	A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState	string	A implementação do modelo não está concluída.
ModelDeprecated	string	Modelo preterido.
ModelExists	string	O modelo existe.
ModelMismatch	string	Erro de correspondência do modelo.
ModelNotDeployable	string	Modelo não implementável.
ModelVersionIncorrect	string	Versão do Modelo Incorreta.
NoUtf8WithBom	string	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Apenas um dos URLs, contentor ou conjunto de dados.
ProjectGenderMismatch	string	Erro de correspondência de género do projeto.
QuotaViolation	string	Violação de quota.
SingleDefaultEndpoint	string	Ponto final predefinido único.
SkuLimitsExist	string	Existem limites de SKU.
SubscriptionNotFound	string	Subscrição não encontrada.
UnexpectedError	string	Erro inesperado.
UnsupportedClassBasedAdaptation	string	Adaptação baseada em classes não suportada.
UnsupportedDelta	string	Delta não suportado.
UnsupportedDynamicConfiguration	string	Configuração dinâmica não suportada.
UnsupportedFilter	string	Filtro não suportado.
UnsupportedLanguageCode	string	Código de idioma não suportado.
UnsupportedOrderBy	string	Encomenda não suportada por.
UnsupportedPagination	string	Paginação não suportada.
UnsupportedTimeRange	string	Intervalo de tempo não suportado.

EntityError

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

EntityReference

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

Error

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

CódigoDoErro

Name	Tipo	Description
Conflict	string	Representando o código de erro de conflito.
Forbidden	string	Representando o código de erro proibido.
InternalCommunicationFailed	string	A representação do código de erro de comunicação interna falhou.
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 pedido inválido.
NotAllowed	string	Representando o código de erro não permitido.
NotFound	string	Representa 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 demasiados pedidos.
Unauthorized	string	Representa o código de erro não autorizado.
UnprocessableEntity	string	Representando o código de erro de entidade não processado.
UnsupportedMediaType	string	Representando o código de erro de tipo de suporte de dados não suportado.

Evaluation

Avaliação

Name	Tipo	Description
createdDateTime	string	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	O nome a apresentar do objeto.
lastActionDateTime	string	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	A região dos dados contidos.
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string	A localização desta entidade.
status	Status	Estado Descrever o estado atual da API
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

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

EvaluationProperties

Name	Tipo	Description
correctTokenCount1	integer	O número de tokens reconhecidos corretamente por model1.
correctTokenCount2	integer	O número de tokens reconhecidos corretamente por model2.
correctWordCount1	integer	O número de palavras reconhecidas corretamente por model1.
correctWordCount2	integer	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	O número de frases processadas por model1.
sentenceCount2	integer	O número de frases processadas por model2.
sentenceErrorRate1	number	A taxa de erro de frase de reconhecimento com model1.
sentenceErrorRate2	number	A taxa de erro de frase de reconhecimento com model2.
tokenCount1	integer	O número de tokens processados por model1.
tokenCount2	integer	O número de tokens processados por model2.
tokenDeletionCount1	integer	O número de tokens reconhecidos por model1, que são eliminações.
tokenDeletionCount2	integer	O número de tokens reconhecidos por model2, que são eliminações.
tokenErrorRate1	number	A taxa de erros de token de reconhecimento com model1.
tokenErrorRate2	number	A taxa de erros de token de reconhecimento com model2.
tokenInsertionCount1	integer	O número de tokens reconhecidos por model1, que são inserções.
tokenInsertionCount2	integer	O número de tokens reconhecidos por model2, que são inserções.
tokenSubstitutionCount1	integer	O número de tokens reconhecidos por model1, que são substituições.
tokenSubstitutionCount2	integer	O número 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 eliminações.
wordDeletionCount2	integer	O número de palavras reconhecidas por model2, que são eliminações.
wordErrorRate1	number	A palavra taxa de erro de reconhecimento com model1.
wordErrorRate2	number	A palavra taxa de erro 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.

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

Name	Tipo	Description
@nextLink	string	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

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

Estado

Name	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á atualmente a ser processada.
Succeeded	string	A operação de execução prolongada foi concluída com êxito.

Partilhar via

Projects - List Evaluations

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Get all evaluations

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

PaginatedEvaluations

Status

Recursos adicionais