Condividi tramite

Datasets - List

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

Ottiene un elenco di set di dati per la sottoscrizione autenticata.

GET {endpoint}/speechtotext/v3.2-preview.2/datasets
Con parametri facoltativi: 
GET {endpoint}/speechtotext/v3.2-preview.2/datasets?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).
filter
 query

string

Espressione di filtro per la selezione di un subset dei set di dati disponibili.

        - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind.

        - Operators:

          - eq, ne are supported for all properties.

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

          - and, or, not are supported.

        -Example:

         filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset'
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

PaginatedDatasets

OK

Intestazioni

Retry-After: integer
Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave dell'account di Servizi cognitivi.

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 acoustic datasets
Get all datasets

Get all acoustic datasets

Esempio di richiesta

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?skip=0&top=10&filter=kind%20eq%20'Acoustic'

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",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    }
  ]
}

Get all datasets

Esempio di richiesta

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?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",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c",
      "kind": "Language",
      "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "acceptedLineCount": 11,
        "rejectedLineCount": 2
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language dataset"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definizioni

Nome Descrizione
Dataset

Set di dati
DatasetKind

DatasetKind
DatasetLinks

DatasetLinks
DatasetProperties

DatasetProperties
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
EntityReference

EntityReference
Error

Errore
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedDatasets

ImpaginatiDataset
Status

Stato
TextNormalizationKind

TextNormalizationKind

Dataset

Object

Set di dati

Nome Tipo Descrizione
contentUrl

string (uri)

URL dei dati per il set di dati.
createdDateTime

string (date-time)

Timestamp al momento della creazione dell'oggetto. Il timestamp è codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
description

string

Descrizione dell'oggetto .
displayName

string

minLength: 1

Nome visualizzato dell'oggetto.
kind

DatasetKind

DatasetKind
Tipo di importazione dei dati.
lastActionDateTime

string (date-time)

Timestamp quando è stato immesso lo stato corrente. Il timestamp è codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

DatasetLinks

DatasetLinks
locale

string

minLength: 1

Impostazioni locali dei dati contenuti.
project

EntityReference

EntityReference
properties

DatasetProperties

DatasetProperties
self

string (uri)

Posizione dell'entità.
status

Status

Stato
Descrivere lo stato corrente dell'API

DatasetKind

Enumerazione

DatasetKind

Valore Descrizione
Acoustic

Un set di dati acustico.
AudioFiles

Set di dati di file audio.
Language

Un set di dati linguistico.
LanguageMarkdown

Set di dati markdown della lingua.
OutputFormatting

Set di dati che contiene regole per personalizzare la normalizzazione del testo inversa, la capitalizzazione, la riformazione, il contenuto volgare e definisce anche i test per la convalida del set di dati
Pronunciation

Set di dati di pronuncia.
Object

DatasetLinks

Nome Tipo Descrizione
commitBlocks

string (uri)

Percorso in cui eseguire il commit dell'elenco di blocchi durante il caricamento di un set di dati tramite blocchi. Per altri dettagli, vedere l'operazione "Datasets_CommitBlocks".
files

string (uri)

Percorso per ottenere tutti i file di questa entità. Per altri dettagli, vedere l'operazione "Datasets_ListFiles".
listBlocks

string (uri)

Percorso in cui elencare i blocchi già caricati di questa entità durante il caricamento di un set di dati tramite blocchi. Per altri dettagli, vedere l'operazione "Datasets_GetBlocks".
uploadBlocks

string (uri)

Percorso in cui caricare i blocchi durante il caricamento di un set di dati tramite blocchi. Per altri dettagli, vedere l'operazione "Datasets_UploadBlock".

DatasetProperties

Object

DatasetProperties

Nome Tipo Descrizione
acceptedLineCount

integer (int32)

Numero di righe accettate per questo set di dati.
duration

string

Durata totale dei set di dati se contiene file audio. La durata viene codificata come durata ISO 8601 ("PnYnMnDTnHnMnS", vedere https://en.wikipedia.org/wiki/ISO_8601#Durations).
email

string

Indirizzo di posta elettronica a cui inviare notifiche tramite posta elettronica nel caso in cui l'operazione venga completata. Il valore verrà rimosso dopo aver inviato correttamente il messaggio di posta elettronica.
error

EntityError

EntityError
rejectedLineCount

integer (int32)

Numero di righe rifiutate per questo set di dati.
textNormalizationKind

TextNormalizationKind

TextNormalizationKind
Tipo di normalizzazione del testo.

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore Descrizione
DataImportFailed

Importazione 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

Non consentito.
InUseViolation

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 di 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 registrazioni non valide.
InvalidRequestBodyFormat

Formato del corpo della richiesta non valido.
InvalidSasValidityDuration

Durata di 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 non valido per la durata.
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 del 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 sulla 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 da.
UnsupportedPagination

Impaginazione non supportata.
UnsupportedTimeRange

Intervallo di tempo non supportato.

EntityError

Object

EntityError

Nome Tipo Descrizione
code

string

Codice di questo errore.
message

string

Messaggio per questo errore.

EntityReference

Object

EntityReference

Nome Tipo Descrizione
self

string (uri)

Posizione dell'entità a cui si fa riferimento.

Error

Object

Errore

Nome Tipo Descrizione
code

ErrorCode

ErrorCode
Codici di errore di alto livello.
details

Error[]

Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida per l'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, details(coppia chiave-valore), errore interno(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

ErrorCode

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

Rappresenta il codice di errore dell'argomento non valido.
InvalidRequest

Rappresenta il codice di errore della richiesta non valido.
NotAllowed

Rappresenta il codice di errore non consentito.
NotFound

Rappresentazione del codice di errore non trovato.
PipelineError

Rappresentazione del codice di errore della pipeline.
ServiceUnavailable

Rappresenta il codice di errore del servizio non disponibile.
TooManyRequests

Rappresenta il codice di errore troppe richieste.
Unauthorized

Rappresenta il codice di errore non autorizzato.
UnprocessableEntity

Rappresenta il codice di errore dell'entità non elaborabile.
UnsupportedMediaType

Rappresenta il codice di errore del tipo di supporto non supportato.

InnerError

Object

InnerError

Nome Tipo Descrizione
code

DetailedErrorCode

DetailedErrorCode
Enumerazione dettagliata del codice di errore.
details

object

Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida per l'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, details(coppia chiave-valore), errore interno(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.

PaginatedDatasets

Object

ImpaginatiDataset

Nome Tipo Descrizione
@nextLink

string (uri)

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

Dataset[]

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

Durante 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.

Status

Enumerazione

Stato

Valore Descrizione
Failed

L'operazione a esecuzione prolungata non è riuscita.
NotStarted

L'operazione a esecuzione prolungata non è ancora stata avviata.
Running

L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded

L'operazione a esecuzione prolungata è stata completata correttamente.

TextNormalizationKind

Enumerazione

TextNormalizationKind

Valore Descrizione
Default

La normalizzazione del testo predefinita ,ad esempio 'da 2 a 3' viene sostituita da 'due a tre' in en-US.
None

Al testo di input non verrà applicata alcuna normalizzazione del testo. Si tratta di un'opzione di override che deve essere usata solo quando il testo viene normalizzato prima del caricamento.