Models - List Files

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

Obtém os arquivos do modelo identificado pela ID fornecida.

GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}/files
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.2-preview.2/models/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&skip={skip}&top={top}&filter={filter}

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 do modelo.
filter
 query

string

Uma expressão de filtragem para selecionar um subconjunto dos arquivos 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 uma URL SAS deve ser válida. A duração padrão é de 12 horas. Ao usar 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 um URI de blob sem token SAS será gerado.
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 depois de ignorar.

Respostas

Nome 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 sua chave de 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. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all files

Solicitação de exemplo

GET {endpoint}/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Resposta de exemplo

Código de status:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "ModelReport",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/report.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/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definições

Nome Description
DetailedErrorCode

DetailedErrorCode
Error

Erro
ErrorCode

ErrorCode
File

Arquivo
FileKind

FileKind
FileLinks

FileLinks
FileProperties

Fileproperties
InnerError

InnerError
PaginatedFiles

PaginatedFiles

DetailedErrorCode

DetailedErrorCode

Nome Tipo Description
DataImportFailed

string

Falha na importação de dados.
DeleteNotAllowed

string

Exclusão não permitida.
DeployNotAllowed

string

Implantação não permitida.
DeployingFailedModel

string

Implantando um modelo com falha.
EmptyRequest

string

Solicitação vazia.
EndpointCannotBeDefault

string

O ponto de extremidade não pode ser padrão.
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

Negado.
InUseViolation

string

Violação de uso.
InaccessibleCustomerStorage

string

Armazenamento inacessível do cliente.
InvalidAdaptationMapping

string

Mapeamento de adaptação inválido.
InvalidBaseModel

string

Modelo base inválido.
InvalidCallbackUri

string

URI de retorno de chamada 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

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álida.
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 web hook inválido.
MissingInputRecords

string

Registros de entrada ausentes.
ModelCopyOperationExists

string

A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState

string

O estado de implantação do modelo não foi concluído.
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.
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.

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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

ErrorCode

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 de serviço indisponível.
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.

File

Arquivo

Nome Tipo Description
createdDateTime

string

A hora de criação desse arquivo. 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 desse arquivo.
properties

FileProperties

Fileproperties
self

string

O local dessa entidade.

FileKind

FileKind

Nome Tipo Description
AcousticDataArchive

string

O tipo de dados é um arquivo acústico de dados.
AcousticDataTranscriptionV2

string

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

string

O tipo de dados é áudio.
DatasetReport

string

O tipo de dados é um relatório de conjunto de dados.
EvaluationDetails

string

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

string

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

string

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

string

O tipo de dados é o arquivo 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 é o relatório de transcrição.

FileLinks

Nome Tipo Description
contentUrl

string

A URL para recuperar o conteúdo desse arquivo.

FileProperties

Fileproperties

Nome Tipo Description
duration

string

A duração no caso desse arquivo ser um arquivo 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

Nome Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração de código de erro detalhada.
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. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message

string

Mensagem de erro de alto nível.
target

string

A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

PaginatedFiles

PaginatedFiles

Nome Tipo Description
@nextLink

string

Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo.
values

File[]

Uma lista de entidades limitada pelos parâmetros de consulta 'skip' e 'top' passados ou seus valores padrão.

Ao iterar por meio de uma lista usando paginação e excluir entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.