Condividi tramite

Datasets - List Files

  • Riferimento
Servizio:
Azure AI Services
Versione API:
v3.2-preview.2

Ottiene i file del set di dati identificato dall'ID specificato.

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/{id}/files
Con parametri facoltativi: 
GET {endpoint}/speechtotext/v3.2-preview.2/datasets/{id}/files?sasValidityInSeconds={sasValidityInSeconds}&skip={skip}&top={top}&filter={filter}

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus.api.cognitive.microsoft.com).
id
 path True

string (uuid)

Identificatore del set di dati.
filter
 query

string

Espressione di filtro per la selezione di un subset dei file disponibili.

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

Durata in secondi in cui deve essere valido un URL di firma di accesso condiviso. La durata predefinita è 12 ore. Quando si usa 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): il valore 0 indica che verrà generato un URI BLOB normale senza token di firma di accesso condiviso.
skip
 query

integer (int32)

Numero di set di dati che verranno ignorati.
top
 query

integer (int32)

Numero di set di dati che verranno inclusi dopo aver ignorato.

Risposte

Nome Tipo Descrizione
200 OK

PaginatedFiles

Va bene

Intestazioni

Retry-After: integer
Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal token JWT restituito dal servizio token di sicurezza di questa area. Assicurarsi di aggiungere l'ambito di gestione al token aggiungendo la stringa di query seguente all'URL sts: ?scope=speechservicesmanagement

Tipo: apiKey
In: header

Esempio

Get all dataset report files
Get all files

Get all dataset report files

Esempio di richiesta

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasValidityInSeconds=120&skip=0&top=10&filter=kind%20eq%20'DatasetReport'

Risposta di esempio

Codice di stato:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "DatasetReport",
      "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"
      }
    }
  ]
}

Get all files

Esempio di richiesta

GET {endpoint}/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?sasValidityInSeconds=120&skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Risposta di esempio

Codice di stato:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/ee4733cd-b1a7-4813-87e2-00d582c28a29",
      "name": "report.json",
      "kind": "DatasetReport",
      "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"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files/f035cf2d-4051-4131-85e7-97e3a7349c86",
      "name": "language_data.txt",
      "kind": "LanguageData",
      "properties": {
        "size": 200
      },
      "createdDateTime": "2020-01-13T08:00:00Z",
      "links": {
        "contentUrl": "https://customspeech-usw.blob.core.windows.net/artifacts/language_data.txt?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/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definizioni

Nome Descrizione
DetailedErrorCode

DetailedErrorCode
Error

Errore
ErrorCode

Codice Errore
File

Documento
FileKind

FileKind
FileLinks

FileLinks
FileProperties

Proprietà file
InnerError

InnerError
PaginatedFiles

File impaginati

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore Descrizione
DataImportFailed

Importazione dei dati non riuscita.
DeleteNotAllowed

Eliminazione non consentita.
DeployNotAllowed

Distribuzione non consentita.
DeployingFailedModel

Distribuzione del modello non riuscito.
EmptyRequest

Richiesta vuota.
EndpointCannotBeDefault

L'endpoint non può essere predefinito.
EndpointNotUpdatable

Endpoint non aggiornabile.
EndpointWithoutLogging

Endpoint senza registrazione.
ExceededNumberOfRecordingsUris

È stato superato il numero di URI delle registrazioni.
FailedDataset

Set di dati non riuscito.
Forbidden

Vietato.
InUseViolation

In violazione dell'uso.
InaccessibleCustomerStorage

Archiviazione dei clienti inaccessibile.
InvalidAdaptationMapping

Mapping di adattamento non valido.
InvalidBaseModel

Modello di base non valido.
InvalidCallbackUri

URI di callback non valido.
InvalidCollection

Raccolta non valida.
InvalidDataset

Set di dati non valido.
InvalidDocument

Documento non valido.
InvalidDocumentBatch

Batch di documenti non valido.
InvalidLocale

Impostazioni locali non valide.
InvalidLogDate

Data del log non valida.
InvalidLogEndTime

Ora di fine del log non valida.
InvalidLogId

ID log non valido.
InvalidLogStartTime

Ora di inizio del log non valida.
InvalidModel

Modello non valido.
InvalidModelUri

URI del modello non valido.
InvalidParameter

Parametro non valido.
InvalidParameterValue

Valore del parametro non valido.
InvalidPayload

Payload non valido.
InvalidPermissions

Autorizzazioni non valide.
InvalidPrerequisite

Prerequisito non valido.
InvalidProductId

ID prodotto non valido.
InvalidProject

Progetto non valido.
InvalidProjectKind

Tipo di progetto non valido.
InvalidRecordingsUri

URI delle registrazioni non valido.
InvalidRequestBodyFormat

Formato del corpo della richiesta non valido.
InvalidSasValidityDuration

Durata della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs

Token skip non valido per i log.
InvalidSourceAzureResourceId

ID risorsa di Azure di origine non valido.
InvalidSubscription

Sottoscrizione non valida.
InvalidTest

Test non valido.
InvalidTimeToLive

Tempo di vita non valido.
InvalidTopForLogs

Top non valido per i log.
InvalidTranscription

Trascrizione non valida.
InvalidWebHookEventKind

Tipo di evento web hook non valido.
MissingInputRecords

Record di input mancanti.
ModelCopyOperationExists

Esiste un'operazione di copia del modello.
ModelDeploymentNotCompleteState

Lo stato della distribuzione del modello non è completo.
ModelDeprecated

Modello deprecato.
ModelExists

Il modello esiste.
ModelMismatch

Mancata corrispondenza del modello.
ModelNotDeployable

Modello non distribuibile.
ModelVersionIncorrect

Versione del modello non corretta.
NoUtf8WithBom

Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset

Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch

Mancata corrispondenza di genere del progetto.
QuotaViolation

Violazione della quota.
SingleDefaultEndpoint

Singolo endpoint predefinito.
SkuLimitsExist

Esistono limiti di SKU.
SubscriptionNotFound

Sottoscrizione non trovata.
UnexpectedError

Errore imprevisto.
UnsupportedClassBasedAdaptation

Adattamento basato su classe non supportato.
UnsupportedDelta

Delta non supportato.
UnsupportedDynamicConfiguration

Configurazione dinamica non supportata.
UnsupportedFilter

Filtro non supportato.
UnsupportedLanguageCode

Codice del linguaggio non supportato.
UnsupportedOrderBy

Ordine non supportato per.
UnsupportedPagination

Impaginazione non supportata.
UnsupportedTimeRange

Intervallo di tempo non supportato.

Error

Object

Errore

Nome Tipo Descrizione
code

ErrorCode

Codice Errore
Codici di errore di alto livello.
details

Error[]

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

Codice Errore

Valore Descrizione
Conflict

Rappresentazione del codice di errore del conflitto.
Forbidden

Rappresentazione del codice di errore non consentito.
InternalCommunicationFailed

Rappresentazione del codice di errore della comunicazione interna non riuscita.
InternalServerError

Rappresentazione del codice di errore interno del server.
InvalidArgument

Rappresentazione del codice di errore dell'argomento non valido.
InvalidRequest

Rappresentazione del codice di errore della richiesta non valido.
NotAllowed

Rappresentazione del codice di errore non consentito.
NotFound

Rappresentazione del codice di errore non trovato.
PipelineError

Rappresentazione del codice di errore della pipeline.
ServiceUnavailable

Rappresentazione del codice di errore del servizio non disponibile.
TooManyRequests

Rappresentazione del codice di errore troppe richieste.
Unauthorized

Rappresentazione del codice di errore non autorizzato.
UnprocessableEntity

Rappresentazione del codice di errore dell'entità non elaborabile.
UnsupportedMediaType

Rappresentazione del codice di errore del tipo di supporto non supportato.

File

Object

Documento

Nome Tipo Descrizione
createdDateTime

string (date-time)

Ora di creazione del file. Il timestamp è codificato come formato di data e ora ISO 8601 (vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
kind

FileKind

FileKind
Tipo di dati.
links

FileLinks

FileLinks
name

string

Nome del file.
properties

FileProperties

Proprietà file
self

string (uri)

Posizione dell'entità.

FileKind

Enumerazione

FileKind

Valore Descrizione
AcousticDataArchive

Il tipo di dati è l'archivio dati acustico.
AcousticDataTranscriptionV2

Il tipo di dati è la trascrizione dei dati acustici v2.
Audio

Il tipo di dati è audio.
DatasetReport

Il tipo di dati è il report del set di dati.
EvaluationDetails

Il tipo di dati è dettagli di valutazione.
LanguageData

Il tipo di dati è dati linguistici.
ModelReport

Il tipo di dati è il report del modello.
OutputFormattingData

Il tipo di dati è il file di input di formattazione dell'output.
PronunciationData

Il tipo di dati è dati di pronuncia.
Transcription

Il tipo di dati è la trascrizione.
TranscriptionReport

Il tipo di dati è il report di trascrizione.
Object

FileLinks

Nome Tipo Descrizione
contentUrl

string (uri)

URL per recuperare il contenuto di questo file.

FileProperties

Object

Proprietà file

Nome Tipo Descrizione
duration

string

La durata nel caso in cui questo file sia un file audio. La durata viene codificata come durata ISO 8601 ("PnYnMnDTnHnMnS", vedere https://en.wikipedia.org/wiki/ISO_8601#Durations).
size

integer (int64)

Dimensioni dei dati in byte.

InnerError

Object

InnerError

Nome Tipo Descrizione
code

DetailedErrorCode

DetailedErrorCode
Enumerazione dettagliata del codice di errore.
details

object

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

PaginatedFiles

Object

File impaginati

Nome Tipo Descrizione
@nextLink

string (uri)

Collegamento al set successivo di risultati impaginati se sono disponibili più entità; in caso contrario null.
values

File[]

Elenco di entità limitate dai parametri di query passati 'skip' e 'top' o dai relativi valori predefiniti.

Quando si esegue l'iterazione di un elenco usando la paginazione e l'eliminazione di entità in parallelo, alcune entità verranno ignorate nei risultati. È consigliabile compilare un elenco nel client ed eliminarlo dopo il recupero dell'elenco completo.