Models - List Files

Referência

Serviço:: Azure AI Services

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

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

GET {endpoint}/speechtotext/models/{id}/files?api-version=2024-11-15

Com parâmetros opcionais:

GET {endpoint}/speechtotext/models/{id}/files?sasLifetimeMinutes={sasLifetimeMinutes}&skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	O identificador do modelo.
api-version	query	True	string	A versão da api solicitada.
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'`
sasLifetimeMinutes	query		integer int32	Este parâmetro define a duração, em minutos, para a qual uma URL SAS deve ser válida. `The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token.`
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.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a chave da sua conta de serviços cognitivos aqui.

Respostas

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

Name

Tipo

Description

200 OK

PaginatedFiles

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

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

Tipo: apiKey
Em: header

Exemplos

Get all files

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?sasLifetimeMinutes=360&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files/ee4733cd-b1a7-4813-87e2-00d582c28a29?api-version=3.2",
      "name": "report.json",
      "kind": "ModelReport",
      "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"
      },
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Erro
ErrorCode	Código de erro
File	Ficheiro
FileKind	FileKind
FileLinks	Links de arquivo
FileProperties	Propriedades do arquivo
InnerError	InnerError
PaginatedFiles	PaginatedFiles

DetailedErrorCode

Name	Tipo	Description
AudioLengthLimitExceeded	string	O arquivo de áudio é maior do que a duração máxima permitida.
BadChannelConfiguration	string	Há uma incompatibilidade entre os canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	Excluir não permitido.
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	Pedido vazio.
EndpointCannotBeDefault	string	O ponto de extremidade não pode ser padrão.
EndpointLoggingNotSupported	string	Não há suporte para registro de ponto final.
EndpointNotUpdatable	string	Ponto final não atualizável.
EndpointWithoutLogging	string	Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris	string	Excedeu o número de gravações uris.
FailedDataset	string	Conjunto de dados com falha.
Forbidden	string	Proibido.
InUseViolation	string	Violação em uso.
InaccessibleCustomerStorage	string	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidAudioFormat	string	O formato de entrada de áudio não é suportado.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	Uri de retorno de chamada inválido.
InvalidChannelSpecification	string	A seleção de canais na solicitação de transcrição não é suportada (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 registo inválida.
InvalidLogEndTime	string	Hora de fim de log inválida.
InvalidLogId	string	ID de log inválido.
InvalidLogStartTime	string	Hora de início de 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	Carga útil inválida.
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	Gravações inválidas uri.
InvalidRequestBodyFormat	string	Formato de corpo de solicitação inválido.
InvalidSasValidityDuration	string	Duração de validade sas inválida.
InvalidSkipTokenForLogs	string	Token de pulo inválido para logs.
InvalidSourceAzureResourceId	string	ID de recurso do Azure de origem inválida.
InvalidSubscription	string	Subscrição 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 do modelo não concluída estado.
ModelDeprecated	string	Modelo preterido.
ModelExists	string	Modelo existe.
ModelMismatch	string	Incompatibilidade de modelos.
ModelNotDeployable	string	Modelo não implantável.
ModelVersionIncorrect	string	Versão do modelo incorreta.
MultipleLanguagesIdentified	string	A Identificação Linguística reconheceu vários idiomas. Nenhuma língua dominante pôde ser determinada.
NoLanguageIdentified	string	A Identificação Linguística não reconhecia nenhuma língua.
NoUtf8WithBom	string	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch	string	Desfasamento entre homens e mulheres no projeto.
QuotaViolation	string	Violação de quotas.
SingleDefaultEndpoint	string	Ponto de extremidade padrão único.
SkuLimitsExist	string	Existem limites de Sku.
SubscriptionNotFound	string	Subscrição não encontrada.
UnexpectedError	string	Erro inesperado.
UnsupportedClassBasedAdaptation	string	Adaptação baseada em classe sem suporte.
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	Ordem 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ódigo de erro Códigos de erro de alto nível.
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

ErrorCode

Código de erro

Name	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álida.
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 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	Links de arquivo
name	string	O nome deste ficheiro.
properties	FileProperties	Propriedades do arquivo
self	string	A localização desta entidade.

FileKind

Name	Tipo	Description
AcousticDataArchive	string	Tipo de dados é arquivo de dados acústicos.
AcousticDataTranscriptionV2	string	O tipo de dados é a transcrição de dados acústicos v2.
Audio	string	O tipo de dados é áudio.
DatasetReport	string	Tipo de dados é relatório de conjunto de dados.
EvaluationDetails	string	Tipo de dados são detalhes da avaliação.
LanguageData	string	Tipo de dados são dados de idioma.
ModelReport	string	Tipo de dados é relatório modelo.
OutputFormattingData	string	Tipo de dados é o arquivo de entrada de formatação de saída.
PronunciationData	string	Tipo de dados são dados de pronúncia.
Transcription	string	O tipo de dados é a transcrição.
TranscriptionReport	string	Tipo de dados é relatório de transcrição.

FileLinks

Links de arquivo

Name	Tipo	Description
contentUrl	string	A url para recuperar o conteúdo deste arquivo.

FileProperties

Propriedades do arquivo

Name	Tipo	Default value	Description
durationMilliseconds	integer	0	A duração total em milissegundos do arquivo, caso este arquivo seja um arquivo de áudio.
size	integer		O tamanho dos dados em bytes.

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Código de erro detalhado enum.
details	object	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de 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, mensagem e destino de propriedades opcionais, detalhes (par de valores 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, seria "documentos" ou "id do documento" no caso de documento inválido.

PaginatedFiles

Name	Tipo	Description
@nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais entidades disponíveis; caso contrário, null.
values	File[]	Uma lista de entidades limitadas pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão. Ao iterar através de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. Recomenda-se criar uma lista no cliente e excluir após a busca da lista completa.

Name

Tipo

Description

@nextLink

string

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

values

File[]

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

Ao iterar através de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. Recomenda-se criar uma lista no cliente e excluir após a busca da lista completa.

Partilhar via

Models - List Files

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Get all files

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

Error

ErrorCode

File

FileKind

FileLinks

FileProperties

InnerError

PaginatedFiles

Recursos adicionais