Delen via


Transcriptions - List

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

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions
GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?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 transcripties.

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

        - 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
skip
query

integer (int32)

Aantal gegevenssets dat wordt overgeslagen.

top
query

integer (int32)

Het aantal gegevenssets dat wordt opgenomen na het overslaan.

Antwoorden

Name Type Description
200 OK

PaginatedTranscriptions

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 querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get all failed transcriptions
Get all transcriptions

Get all failed transcriptions

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip=0&top=2&filter=status%20eq%20'Failed'

Voorbeeldrespons

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ]
}

Get all transcriptions

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?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/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": false,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
      },
      "properties": {
        "diarizationEnabled": false,
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definities

Name Description
DetailedErrorCode

DetailedErrorCode

DiarizationProperties

DiarizationProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

EntityError

EntityError

EntityReference

EntityReference

Error

Fout

ErrorCode

ErrorCode

InnerError

InnerError

LanguageIdentificationMode

LanguageIdentificationMode

LanguageIdentificationProperties

LanguageIdentificationProperties

PaginatedTranscriptions

GepagineerdeTranscriptions

ProfanityFilterMode

ProfanityFilterMode

PunctuationMode

Interpunctiemodus

Status

Toestand

Transcription

Transcriptie

TranscriptionLinks

TranscriptionLinks

TranscriptionProperties

TranscriptieProperties

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

Niet-toegankelijke opslag van klanten.

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 voor logboeken.

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

Ongeldig projecttype.

InvalidRecordingsUri

Ongeldige opnamen-URI.

InvalidRequestBodyFormat

Ongeldige indeling voor de hoofdtekst van de aanvraag.

InvalidSasValidityDuration

Ongeldige geldigheidsduur van SAS.

InvalidSkipTokenForLogs

Ongeldig skip-token voor logboeken.

InvalidSourceAzureResourceId

Ongeldige azure-bronresource-id.

InvalidSubscription

Ongeldig abonnement.

InvalidTest

Ongeldige test.

InvalidTimeToLive

Ongeldige time to live.

InvalidTopForLogs

Ongeldig bovenaan voor logboeken.

InvalidTranscription

Ongeldige transcriptie.

InvalidWebHookEventKind

Ongeldig gebeurtenistype webhook.

MissingInputRecords

Ontbrekende invoerrecords.

ModelCopyOperationExists

Er bestaat een modelkopiebewerking.

ModelDeploymentNotCompleteState

Modelimplementatie is niet voltooid.

ModelDeprecated

Model 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 url's of containers of gegevenssets.

ProjectGenderMismatch

Project geslacht komt niet overeen.

QuotaViolation

Quotumschending.

SingleDefaultEndpoint

Eén standaardeindpunt.

SkuLimitsExist

Er bestaan SKU-limieten.

SubscriptionNotFound

Abonnement is niet gevonden.

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 volgorde door.

UnsupportedPagination

Niet-ondersteunde paginering.

UnsupportedTimeRange

Niet-ondersteund tijdsbereik.

DiarizationProperties

DiarizationProperties

Name Type Description
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Name Type Description
maxCount

integer (int32)

minimum: 1

Het maximum aantal sprekers voor diarisatie. Moet kleiner zijn dan 36 en groter dan of gelijk aan de minSpeakers-eigenschap.

minCount

integer (int32)

minimum: 1

Een hint voor het minimale aantal sprekers voor diarisatie. Moet kleiner zijn dan of gelijk zijn aan de eigenschap maxSpeakers.

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 over de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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

Vertegenwoordiging van de conflictfoutcode.

Forbidden

Vertegenwoordiging van de verboden foutcode.

InternalCommunicationFailed

De foutcode voor de interne communicatie is mislukt.

InternalServerError

De foutcode van de interne server vertegenwoordigt.

InvalidArgument

De foutcode van het ongeldige argument vertegenwoordigt.

InvalidRequest

De foutcode van de ongeldige aanvraag vertegenwoordigt.

NotAllowed

Vertegenwoordiging van de niet-toegestane foutcode.

NotFound

De foutcode wordt niet gevonden.

PipelineError

De foutcode van de pijplijnfout weergeven.

ServiceUnavailable

Vertegenwoordiging van de service niet-beschikbare foutcode.

TooManyRequests

De foutcode voor te veel aanvragen vertegenwoordigt.

Unauthorized

Vertegenwoordiging van de niet-geautoriseerde foutcode.

UnprocessableEntity

De foutcode van de niet-verwerkte entiteit vertegenwoordigt.

UnsupportedMediaType

De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.

InnerError

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde opsomming van foutcodes.

details

object

Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.

innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, 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.

LanguageIdentificationMode

LanguageIdentificationMode

Waarde Description
Continuous

Continue taalidentificatie (standaard).

Single

Identificatie van één taal.

LanguageIdentificationProperties

LanguageIdentificationProperties

Name Type Default value Description
candidateLocales

string[]

De landinstellingen van de kandidaat voor taalidentificatie (bijvoorbeeld ["en-US", "de-DE", "es-ES"]). Minimaal 2 en maximaal 10 kandidaatlandinstellingen, inclusief de belangrijkste landinstelling voor de transcriptie, worden ondersteund.

mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
De modus die wordt gebruikt voor taalidentificatie.

speechModelMapping

<string,  EntityReference>

Een optionele toewijzing van landinstellingen aan spraakmodelentiteiten. Als er geen model wordt gegeven voor een landinstelling, wordt het standaardbasismodel gebruikt. Sleutels moeten landinstellingen zijn die zijn opgenomen in de kandidaat-landinstellingen. Waarden zijn entiteiten voor modellen van de respectieve landinstellingen.

PaginatedTranscriptions

GepagineerdeTranscriptions

Name Type Description
@nextLink

string (uri)

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

values

Transcription[]

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

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

ProfanityFilterMode

ProfanityFilterMode

Waarde Description
Masked

Masker de grofheid met * behalve de eerste letter, bijvoorbeeld f**

None

Filter op grof taalgebruik uitschakelen.

Removed

Verwijder grof taalgebruik.

Tags

XML-tags toevoegen</Grof taalgebruik>

PunctuationMode

Interpunctiemodus

Waarde Description
Automatic

Automatische interpunctie.

Dictated

Alleen dicteerde interpunctiemarkeringen, dat wil zeggen expliciete interpunctie.

DictatedAndAutomatic

Dicteerde interpunctiemarkeringen of automatische interpunctie.

None

Geen interpunctie.

Status

Toestand

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.

Transcription

Transcriptie

Name Type Description
contentContainerUrl

string (uri)

Een URL voor een Azure Blob-container die de audiobestanden bevat. Een container mag maximaal 5 GB en maximaal 10000 blobs hebben. De maximale grootte voor een blob is 2,5 GB. Container-SAS moet machtigingen 'r' (lezen) en 'l' (lijst) bevatten. Deze eigenschap wordt niet geretourneerd in een antwoord.

contentUrls

string[] (uri)

Een lijst met inhouds-URL's voor het ophalen van audiobestanden om te transcriberen. Maximaal 1000 URL's zijn toegestaan. Deze eigenschap wordt niet geretourneerd in een antwoord.

createdDateTime

string (date-time)

Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt 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 maximale toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.

dataset

EntityReference

EntityReference

description

string

De beschrijving van het object.

displayName

string

minLength: 1

De weergavenaam van het object.

lastActionDateTime

string (date-time)

Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt 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

TranscriptionLinks

TranscriptionLinks

locale

string

minLength: 1

De landinstelling van de ingesloten gegevens. Als taalidentificatie wordt gebruikt, wordt deze landinstelling gebruikt om spraak te transcriberen waarvoor geen taal kan worden gedetecteerd.

model

EntityReference

EntityReference

project

EntityReference

EntityReference

properties

TranscriptionProperties

TranscriptieProperties

self

string (uri)

De locatie van deze entiteit.

status

Status

Toestand
De huidige status van de API beschrijven

TranscriptionLinks

Name Type Description
files

string (uri)

De locatie om alle bestanden van deze entiteit op te halen. Zie de bewerking 'Transcriptions_ListFiles' voor meer informatie.

TranscriptionProperties

TranscriptieProperties

Name Type Description
channels

integer[] (int32)

Een verzameling van de aangevraagde kanaalnummers. In het standaardscenario worden de kanalen 0 en 1 overwogen.

destinationContainerUrl

string (uri)

De aangevraagde doelcontainer.

Opmerkingen

Wanneer een doelcontainer wordt gebruikt in combinatie met een timeToLive, worden de metagegevens van een transcriptie normaal verwijderd, maar blijven de gegevens die zijn opgeslagen in de doelcontainer, inclusief transcriptieresultaten, ongewijzigd, omdat er geen verwijdermachtigingen vereist zijn voor deze container.
Als u automatische opschoning wilt ondersteunen, configureert u de levensduur van de blob in de container of gebruikt u BYOS (Bring Your Own Storage) in plaats van destinationContainerUrl, waar blobs kunnen worden opgeschoond.

diarization

DiarizationProperties

DiarizationProperties

diarizationEnabled

boolean

Een waarde die aangeeft of diarisatie (sprekeridentificatie) wordt aangevraagd. De standaardwaarde is false. Als dit veld is ingesteld op waar en het verbeterde diarisatiesysteem is geconfigureerd door DiarizationPropertiesop te geven, biedt het verbeterde diarisatiesysteem diarisatie voor een configureerbaar bereik van luidsprekers. Als dit veld is ingesteld op true en het verbeterde diarisatiesysteem niet is ingeschakeld (geen DiarizationPropertiesopgeven), maakt het basis diarisatiesysteem onderscheid tussen maximaal twee luidsprekers. Er worden geen extra kosten in rekening gebracht voor de basis-diarisatie.

Het eenvoudige diarisatiesysteem is afgeschaft en wordt verwijderd in de volgende primaire versie van de API. Deze diarizationEnabled instelling wordt ook verwijderd.

displayFormWordLevelTimestampsEnabled

boolean

Een waarde die aangeeft of tijdstempels op woordniveau voor het weergaveformulier worden aangevraagd. De standaardwaarde is false.

duration

string

De duur van de transcriptie. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).

email

string

Het e-mailadres waarnaar e-mailmeldingen moeten worden verzonden voor het geval de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.

error

EntityError

EntityError

languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties

profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
Modus van grof filteren.

punctuationMode

PunctuationMode

Interpunctiemodus
De modus die wordt gebruikt voor interpunctie.

timeToLive

string

Hoe lang de transcriptie in het systeem wordt bewaard nadat deze is voltooid. Zodra de transcriptie de tijd tot leven heeft bereikt na voltooiing (geslaagd of mislukt), wordt deze automatisch verwijderd. Als u deze waarde niet instelt of op 0 instelt, wordt automatisch verwijderen uitgeschakeld. De langste ondersteunde duur is 31 dagen. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).

wordLevelTimestampsEnabled

boolean

Een waarde die aangeeft of tijdstempels op woordniveau worden aangevraagd. De standaardwaarde is false.