Evaluations - List Files

  • Referência
Serviço:
Azure AI Services
Versão da API:
v3.2-preview.2

Obtém os ficheiros da avaliação identificados pelo ID especificado.

GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}/files
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&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 da avaliação.
filter
 query

string

Uma expressão de filtragem para selecionar um subconjunto dos ficheiros disponíveis.

        - Supported properties: name, createdDateTime, kind.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime.

          - and, or, not are supported.

        - Example:

          filter=name eq 'myaudio.wav' and kind eq 'Audio'
sasValidityInSeconds
 query

integer

int32

A duração em segundos em que um URL de SAS deve ser válido. A duração predefinida é de 12 horas. Ao utilizar BYOS (https://video2.skills-academy.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): um valor de 0 significa que será gerado um URI de blobs simples sem token DE SAS.
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

PaginatedFiles

OK

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 files

Pedido de amostra

GET {endpoint}/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files?sasValidityInSeconds=120&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/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/8ad6c551-9d6e-43f7-9649-94680899e77a",
      "name": "mywavefile1.wav.model1_score.json",
      "kind": "EvaluationDetails",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model1_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.model2_score.json",
      "kind": "EvaluationDetails",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.model2_score.json?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=e05d8d56-9675-448b-820c-4318ae64c8d5"
      }
    }
  ],
  "@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
Error

Erro
ErrorCode

CódigoDoErro
File

Ficheiro
FileKind

FileKind
FileLinks

FileLinks
FileProperties

FileProperties
InnerError

InnerError
PaginatedFiles

PaginatedFiles

DetailedErrorCode

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

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 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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

Representa o código de erro de conflito.
Forbidden

string

Representa o código de erro proibido.
InternalCommunicationFailed

string

A representação do código de erro falha na comunicação interna.
InternalServerError

string

Representa o código de erro interno do servidor.
InvalidArgument

string

Representa o código de erro de argumento inválido.
InvalidRequest

string

Representa o código de erro de pedido inválido.
NotAllowed

string

Representa o código de erro não permitido.
NotFound

string

Representa o código de erro não encontrado.
PipelineError

string

Representa o código de erro do pipeline.
ServiceUnavailable

string

Representa o código de erro serviço indisponível.
TooManyRequests

string

Representa o código de erro demasiados pedidos.
Unauthorized

string

Representa o código de erro não autorizado.
UnprocessableEntity

string

Representa o código de erro de entidade não processada.
UnsupportedMediaType

string

Representa o código de erro do tipo de suporte de dados não suportado.

File

Ficheiro

Name Tipo Description
createdDateTime

string

A hora de criação deste ficheiro. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 (consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

FileKind
Tipo de dados.
links

FileLinks

FileLinks
name

string

O nome deste ficheiro.
properties

FileProperties

FileProperties
self

string

A localização desta entidade.

FileKind

FileKind

Name Tipo Description
AcousticDataArchive

string

O tipo de dados é arquivo de dados acústicos.
AcousticDataTranscriptionV2

string

O tipo de dados é transcrição de dados acústicos v2.
Audio

string

O tipo de dados é áudio.
DatasetReport

string

O tipo de dados é o relatório do conjunto de dados.
EvaluationDetails

string

O tipo de dados são os detalhes da avaliação.
LanguageData

string

O tipo de dados são dados de linguagem.
ModelReport

string

O tipo de dados é um relatório de modelo.
OutputFormattingData

string

O tipo de dados é o ficheiro de entrada de formatação de saída.
PronunciationData

string

O tipo de dados são dados de pronúncia.
Transcription

string

O tipo de dados é transcrição.
TranscriptionReport

string

O tipo de dados é um relatório de transcrição.

FileLinks

Name Tipo Description
contentUrl

string

O URL para obter o conteúdo deste ficheiro.

FileProperties

FileProperties

Name Tipo Description
duration

string

A duração no caso deste ficheiro ser um ficheiro de áudio. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", consulte https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer

O tamanho dos dados em bytes.

InnerError

InnerError

Name Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração detalhada do código de erro.
details

object

Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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.

PaginatedFiles

PaginatedFiles

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

File[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou pelos 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.