Partilhar via

Transcriptions - List Files

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

Obtém os arquivos da transcrição identificados pelo ID fornecido.

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{id}/files
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/{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 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 da transcrição.
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.json' and kind eq 'Transcription'
sasValidityInSeconds
 query

integer (int32)

A duração em segundos que um URL SAS deve ser válido. A duração padrão é de 12 horas. Ao usar BYOS (https://learn.microsoft.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 simples 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

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

Tipo: apiKey
Em: header

Exemplos

Get all files
Get all transcription files the name of which starts with the specified string

Get all files

Pedido de amostra

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Resposta da amostra

Código de estado:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/28bc946b-c251-4a86-84f6-ea0f0a2373ef",
      "name": "mywavefile2.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile2.wav.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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?skip=2&top=2"
}

Get all transcription files the name of which starts with the specified string

Pedido de amostra

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?sasValidityInSeconds=120&skip=0&top=10&filter=name%20eq%20'mywavefile1.wav.json'

Resposta da amostra

Código de estado:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "mywavefile1.wav.json",
      "kind": "Transcription",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/mywavefile1.wav.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"
      }
    }
  ]
}

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

Enumeração

DetailedErrorCode

Valor Description
DataImportFailed

Falha na importação de dados.
DeleteNotAllowed

Excluir não permitido.
DeployNotAllowed

Implantação não permitida.
DeployingFailedModel

Implantação de modelo com falha.
EmptyRequest

Pedido vazio.
EndpointCannotBeDefault

O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable

Ponto final não atualizável.
EndpointWithoutLogging

Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris

Excedeu o número de gravações uris.
FailedDataset

Conjunto de dados com falha.
Forbidden

Proibido.
InUseViolation

Violação em uso.
InaccessibleCustomerStorage

Armazenamento inacessível do cliente.
InvalidAdaptationMapping

Mapeamento de adaptação inválido.
InvalidBaseModel

Modelo base inválido.
InvalidCallbackUri

Uri de retorno de chamada inválido.
InvalidCollection

Coleção inválida.
InvalidDataset

Conjunto de dados inválido.
InvalidDocument

Documento inválido.
InvalidDocumentBatch

Lote de documentos inválido.
InvalidLocale

Localidade inválida.
InvalidLogDate

Data de registo inválida.
InvalidLogEndTime

Hora de fim de log inválida.
InvalidLogId

ID de log inválido.
InvalidLogStartTime

Hora de início de log 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

Carga útil inválida.
InvalidPermissions

Permissões inválidas.
InvalidPrerequisite

Pré-requisito inválido.
InvalidProductId

ID do produto inválida.
InvalidProject

Projeto inválido.
InvalidProjectKind

Tipo de projeto inválido.
InvalidRecordingsUri

Gravações inválidas uri.
InvalidRequestBodyFormat

Formato de corpo de solicitação inválido.
InvalidSasValidityDuration

Duração de validade sas inválida.
InvalidSkipTokenForLogs

Token de pulo inválido para logs.
InvalidSourceAzureResourceId

ID de recurso do Azure de origem inválida.
InvalidSubscription

Subscrição inválida.
InvalidTest

Teste inválido.
InvalidTimeToLive

Tempo de vida inválido.
InvalidTopForLogs

Parte superior inválida para logs.
InvalidTranscription

Transcrição inválida.
InvalidWebHookEventKind

Tipo de evento de gancho da Web inválido.
MissingInputRecords

Registros de entrada ausentes.
ModelCopyOperationExists

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

Implantação do modelo não concluída estado.
ModelDeprecated

Modelo preterido.
ModelExists

Modelo existe.
ModelMismatch

Incompatibilidade de modelos.
ModelNotDeployable

Modelo não implantável.
ModelVersionIncorrect

Versão do modelo incorreta.
NoUtf8WithBom

Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset

Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch

Desfasamento entre homens e mulheres no projeto.
QuotaViolation

Violação de quotas.
SingleDefaultEndpoint

Ponto de extremidade padrão único.
SkuLimitsExist

Existem limites de Sku.
SubscriptionNotFound

Subscrição não encontrada.
UnexpectedError

Erro inesperado.
UnsupportedClassBasedAdaptation

Adaptação baseada em classe sem suporte.
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

Ordem não suportada por.
UnsupportedPagination

Paginação não suportada.
UnsupportedTimeRange

Intervalo de tempo não suportado.

Error

Object

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

Enumeração

Código de erro

Valor Description
Conflict

Representando o código de erro de conflito.
Forbidden

Representando o código de erro proibido.
InternalCommunicationFailed

Representando o código de erro de falha de comunicação interna.
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 solicitação inválida.
NotAllowed

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

Representando 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 de muitas solicitações.
Unauthorized

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

Representando o código de erro de entidade não processável.
UnsupportedMediaType

Representando o código de erro de tipo de mídia não suportado.

File

Object

Ficheiro

Name Tipo Description
createdDateTime

string (date-time)

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 (uri)

A localização desta entidade.

FileKind

Enumeração

FileKind

Valor Description
AcousticDataArchive

Tipo de dados é arquivo de dados acústicos.
AcousticDataTranscriptionV2

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

O tipo de dados é áudio.
DatasetReport

Tipo de dados é relatório de conjunto de dados.
EvaluationDetails

Tipo de dados são detalhes da avaliação.
LanguageData

Tipo de dados são dados de idioma.
ModelReport

Tipo de dados é relatório modelo.
OutputFormattingData

Tipo de dados é o arquivo de entrada de formatação de saída.
PronunciationData

Tipo de dados são dados de pronúncia.
Transcription

O tipo de dados é a transcrição.
TranscriptionReport

Tipo de dados é relatório de transcrição.
Object

Links de arquivo

Name Tipo Description
contentUrl

string (uri)

A url para recuperar o conteúdo deste arquivo.

FileProperties

Object

Propriedades do arquivo

Name Tipo Description
duration

string

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

integer (int64)

O tamanho dos dados em bytes.

InnerError

Object

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

Object

PaginatedFiles

Name Tipo Description
@nextLink

string (uri)

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.