Delen via


Datasets - List

Hiermee haalt u een lijst met gegevenssets op voor het geverifieerde abonnement.

GET {endpoint}/speechtotext/v3.2-preview.2/datasets
GET {endpoint}/speechtotext/v3.2-preview.2/datasets?skip={skip}&top={top}&filter={filter}

URI-parameters

Name In Vereist Type Description
endpoint
path True

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).

filter
query

string

Een filterexpressie voor het selecteren van een subset van de beschikbare gegevenssets.

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

Het aantal gegevenssets dat wordt overgeslagen.

top
query

integer (int32)

Het aantal gegevenssets dat wordt opgenomen na het overslaan.

Antwoorden

Name Type Description
200 OK

PaginatedDatasets

OK

Kopteksten

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende queryreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get all acoustic datasets
Get all datasets

Get all acoustic datasets

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/datasets?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Voorbeeldrespons

{
  "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"
}

Definities

Name Description
Dataset

Gegevensset

DatasetKind

DatasetKind

DatasetLinks

DatasetLinks

DatasetProperties

GegevenssetEigenschappen

DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Fout

ErrorCode

ErrorCode

InnerError

InnerError

PaginatedDatasets

PaginatedDatasets

Status

Status

TextNormalizationKind

TextNormalizationKind

Dataset

Gegevensset

Name Type Description
contentUrl

string (uri)

De URL van de gegevens voor de gegevensset.

createdDateTime

string (date-time)

De tijdstempel waarop het object is gemaakt. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximaal toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.

description

string

De beschrijving van het object.

displayName

string

minLength: 1

De weergavenaam van het object.

kind

DatasetKind

DatasetKind
Type gegevensimport.

lastActionDateTime

string (date-time)

Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel is gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

DatasetLinks

DatasetLinks

locale

string

minLength: 1

De landinstelling van de ingesloten gegevens.

project

EntityReference

EntityReference

properties

DatasetProperties

GegevenssetEigenschappen

self

string (uri)

De locatie van deze entiteit.

status

Status

Status
De huidige status van de API beschrijven

DatasetKind

DatasetKind

Waarde Description
Acoustic

Een akoestische gegevensset.

AudioFiles

Een gegevensset met audiobestanden.

Language

Een taalgegevensset.

LanguageMarkdown

Een Markdown-gegevensset voor de taal.

OutputFormatting

Gegevensset met regels voor het aanpassen van inverse tekstnormalisatie, hoofdlettergebruik, herformulering, scheldwoorden en definieert ook tests voor gegevenssetvalidatie

Pronunciation

Een uitspraakgegevensset.

DatasetLinks

Name Type Description
commitBlocks

string (uri)

De locatie voor het doorvoeren van de lijst met blokken bij het uploaden van een gegevensset met behulp van blokken. Zie bewerking 'Datasets_CommitBlocks' voor meer informatie.

files

string (uri)

De locatie voor het ophalen van alle bestanden van deze entiteit. Zie bewerking 'Datasets_ListFiles' voor meer informatie.

listBlocks

string (uri)

De locatie voor het weergeven van de reeds geüploade blokken van deze entiteit bij het uploaden van een gegevensset met behulp van blokken. Zie bewerking 'Datasets_GetBlocks' voor meer informatie.

uploadBlocks

string (uri)

De locatie waarnaar u blokken wilt uploaden bij het uploaden van een gegevensset met behulp van blokken. Zie bewerking 'Datasets_UploadBlock' voor meer informatie.

DatasetProperties

GegevenssetEigenschappen

Name Type Description
acceptedLineCount

integer (int32)

Het aantal regels dat voor deze gegevensset is geaccepteerd.

duration

string

De totale duur van de gegevenssets als deze audiobestanden bevatten. De duur is gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Het e-mailadres waarnaar u e-mailmeldingen wilt verzenden als de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.

error

EntityError

EntityError

rejectedLineCount

integer (int32)

Het aantal regels dat is geweigerd voor deze gegevensset.

textNormalizationKind

TextNormalizationKind

TextNormalizationKind
Het soort tekstnormalisatie.

DetailedErrorCode

DetailedErrorCode

Waarde Description
DataImportFailed

Het importeren van gegevens is mislukt.

DeleteNotAllowed

Verwijderen is niet toegestaan.

DeployNotAllowed

Implementeren is niet toegestaan.

DeployingFailedModel

Het implementeren van een mislukt model.

EmptyRequest

Lege aanvraag.

EndpointCannotBeDefault

Eindpunt kan niet standaard zijn.

EndpointNotUpdatable

Eindpunt kan niet worden bijgewerkt.

EndpointWithoutLogging

Eindpunt zonder logboekregistratie.

ExceededNumberOfRecordingsUris

Het aantal opnamen is overschreden.

FailedDataset

Mislukte gegevensset.

Forbidden

Verboden.

InUseViolation

Schending van gebruik.

InaccessibleCustomerStorage

Ontoegankelijke klantopslag.

InvalidAdaptationMapping

Ongeldige aanpassingstoewijzing.

InvalidBaseModel

Ongeldig basismodel.

InvalidCallbackUri

Ongeldige callback-URI.

InvalidCollection

Ongeldige verzameling.

InvalidDataset

Ongeldige gegevensset.

InvalidDocument

Ongeldig document.

InvalidDocumentBatch

Ongeldige documentbatch.

InvalidLocale

Ongeldige landinstelling.

InvalidLogDate

Ongeldige logboekdatum.

InvalidLogEndTime

Ongeldige eindtijd van logboek.

InvalidLogId

Ongeldige logboek-id.

InvalidLogStartTime

Ongeldige begintijd van logboek.

InvalidModel

Ongeldig model.

InvalidModelUri

Ongeldige model-URI.

InvalidParameter

Ongeldige parameter.

InvalidParameterValue

Ongeldige parameterwaarde.

InvalidPayload

Ongeldige nettolading.

InvalidPermissions

Ongeldige machtigingen.

InvalidPrerequisite

Ongeldige vereiste.

InvalidProductId

Ongeldige product-id.

InvalidProject

Ongeldig project.

InvalidProjectKind

Ongeldige projectsoort.

InvalidRecordingsUri

Ongeldige URI voor opnamen.

InvalidRequestBodyFormat

Ongeldige indeling van aanvraagbody.

InvalidSasValidityDuration

Ongeldige sas-geldigheidsduur.

InvalidSkipTokenForLogs

Ongeldig token voor het overslaan van logboeken.

InvalidSourceAzureResourceId

Ongeldige bron-azure-resource-id.

InvalidSubscription

Ongeldig abonnement.

InvalidTest

Ongeldige test.

InvalidTimeToLive

Ongeldige time to live.

InvalidTopForLogs

Ongeldige bovenkant voor logboeken.

InvalidTranscription

Ongeldige transcriptie.

InvalidWebHookEventKind

Ongeldig soort webhook gebeurtenis.

MissingInputRecords

Ontbrekende invoerrecords.

ModelCopyOperationExists

De modelkopiebewerking bestaat.

ModelDeploymentNotCompleteState

De status modelimplementatie is niet voltooid.

ModelDeprecated

Het model is afgeschaft.

ModelExists

Het model bestaat.

ModelMismatch

Model komt niet overeen.

ModelNotDeployable

Model kan niet worden geïmplementeerd.

ModelVersionIncorrect

Modelversie onjuist.

NoUtf8WithBom

Geen utf8 met bom.

OnlyOneOfUrlsOrContainerOrDataset

Slechts één van de URL's of container of gegevensset.

ProjectGenderMismatch

Het geslacht van het project komt niet overeen.

QuotaViolation

Quotumschending.

SingleDefaultEndpoint

Eén standaardeindpunt.

SkuLimitsExist

Er bestaan SKU-limieten.

SubscriptionNotFound

Kan het abonnement niet vinden.

UnexpectedError

Onverwachte fout.

UnsupportedClassBasedAdaptation

Niet-ondersteunde aanpassing op basis van klassen.

UnsupportedDelta

Niet-ondersteunde delta.

UnsupportedDynamicConfiguration

Niet-ondersteunde dynamische configuratie.

UnsupportedFilter

Niet-ondersteund filter.

UnsupportedLanguageCode

Niet-ondersteunde taalcode.

UnsupportedOrderBy

Niet-ondersteunde bestelling op.

UnsupportedPagination

Niet-ondersteunde paginering.

UnsupportedTimeRange

Niet-ondersteund tijdsbereik.

EntityError

EntityError

Name Type Description
code

string

De code van deze fout.

message

string

Het bericht voor deze fout.

EntityReference

EntityReference

Name Type Description
self

string (uri)

De locatie van de entiteit waarnaar wordt verwezen.

Error

Fout

Name Type Description
code

ErrorCode

ErrorCode
Foutcodes op hoog niveau.

details

Error[]

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Api-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).

message

string

Foutbericht op hoog niveau.

target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

ErrorCode

Waarde Description
Conflict

Vertegenwoordigt de conflictfoutcode.

Forbidden

Vertegenwoordigt de verboden foutcode.

InternalCommunicationFailed

De foutcode voor de interne communicatie is mislukt.

InternalServerError

Vertegenwoordigt de foutcode van de interne serverfout.

InvalidArgument

Vertegenwoordigt de foutcode van het ongeldige argument.

InvalidRequest

Vertegenwoordigt de ongeldige aanvraagfoutcode.

NotAllowed

Vertegenwoordigt de niet-toegestane foutcode.

NotFound

Deze vertegenwoordigt de foutcode niet gevonden.

PipelineError

Vertegenwoordigt de foutcode van de pijplijnfout.

ServiceUnavailable

De foutcode voor de service is niet beschikbaar.

TooManyRequests

Vertegenwoordigt de foutcode voor te veel aanvragen.

Unauthorized

Vertegenwoordigt de foutcode voor onbevoegden.

UnprocessableEntity

Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.

UnsupportedMediaType

Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

InnerError

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde foutcode- enum.

details

object

Aanvullende ondersteunende informatie met betrekking tot de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Api-richtlijnen voor Cognitive Services die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat de vereiste eigenschappen ErrorCode, bericht en optionele eigenschappen doel, details (sleutelwaardepaar), interne fout (dit kan worden genest).

message

string

Foutbericht op hoog niveau.

target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

PaginatedDatasets

PaginatedDatasets

Name Type Description
@nextLink

string (uri)

Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.

values

Dataset[]

Een lijst met entiteiten die beperkt zijn door de doorgegeven queryparameters 'skip' en 'top' of hun standaardwaarden.

Wanneer u een lijst doorloopt met behulp van paginering en entiteiten parallel verwijdert, worden sommige entiteiten overgeslagen in de resultaten. Het is raadzaam om een lijst op de client te maken en te verwijderen nadat de volledige lijst is opgehaald.

Status

Status

Waarde Description
Failed

De langdurige bewerking is mislukt.

NotStarted

De langdurige bewerking is nog niet gestart.

Running

De langdurige bewerking wordt momenteel verwerkt.

Succeeded

De langdurige bewerking is voltooid.

TextNormalizationKind

TextNormalizationKind

Waarde Description
Default

Standaardtekstnormalisatie (bijvoorbeeld '2 tot 3' wordt vervangen door 'twee tot drie' in en-US).

None

Er wordt geen tekstnormalisatie toegepast op de invoertekst. Dit is een onderdrukkingsoptie die alleen moet worden gebruikt wanneer tekst vóór het uploaden wordt genormaliseerd.