Projects - List Transcriptions

Referentie

Service:: Azure AI Services

API-versie:: v3.2-preview.2

Hiermee haalt u de lijst met transcripties voor het opgegeven project op.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions

Met optionele parameters:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/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).
id	path	True	string uuid	De id van het project.
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	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	PaginatedTranscriptions	OK Kopteksten Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

PaginatedTranscriptions

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

Type: apiKey
In: header

Voorbeelden

Get all transcriptions

Voorbeeldaanvraag

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Voorbeeldrespons

Statuscode:: 200

{
  "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	DiarizationSpeakersEigenschappen
EntityError	EntityError
EntityReference	EntityReference
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
PaginatedTranscriptions	GepagineerdeTranscripties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	Interpunctiemodus
Status	Status
Transcription	Transcriptie
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties

DetailedErrorCode

Name	Type	Description
DataImportFailed	string	Het importeren van gegevens is mislukt.
DeleteNotAllowed	string	Verwijderen is niet toegestaan.
DeployNotAllowed	string	Implementeren is niet toegestaan.
DeployingFailedModel	string	Het implementeren van een mislukt model.
EmptyRequest	string	Lege aanvraag.
EndpointCannotBeDefault	string	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	string	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	string	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	string	Het aantal opnamen is overschreden.
FailedDataset	string	Mislukte gegevensset.
Forbidden	string	Verboden.
InUseViolation	string	In gebruiksovertreding.
InaccessibleCustomerStorage	string	Niet-toegankelijke klantopslag.
InvalidAdaptationMapping	string	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	string	Ongeldig basismodel.
InvalidCallbackUri	string	Ongeldige callback-URI.
InvalidCollection	string	Ongeldige verzameling.
InvalidDataset	string	Ongeldige gegevensset.
InvalidDocument	string	Ongeldig document.
InvalidDocumentBatch	string	Ongeldige documentbatch.
InvalidLocale	string	Ongeldige landinstelling.
InvalidLogDate	string	Ongeldige logboekdatum.
InvalidLogEndTime	string	Ongeldige eindtijd van logboek.
InvalidLogId	string	Ongeldige logboek-id.
InvalidLogStartTime	string	Ongeldige begintijd van logboek.
InvalidModel	string	Ongeldig model.
InvalidModelUri	string	Ongeldige model-URI.
InvalidParameter	string	Ongeldige parameter.
InvalidParameterValue	string	Ongeldige parameterwaarde.
InvalidPayload	string	Ongeldige nettolading.
InvalidPermissions	string	Ongeldige machtigingen.
InvalidPrerequisite	string	Ongeldige vereiste.
InvalidProductId	string	Ongeldige product-id.
InvalidProject	string	Ongeldig project.
InvalidProjectKind	string	Ongeldige projectsoort.
InvalidRecordingsUri	string	Ongeldige URI voor opnamen.
InvalidRequestBodyFormat	string	Ongeldige indeling van aanvraagbody.
InvalidSasValidityDuration	string	Ongeldige geldigheidsduur sas.
InvalidSkipTokenForLogs	string	Ongeldig token voor overslaan voor logboeken.
InvalidSourceAzureResourceId	string	Ongeldige bron-id van Azure-resource.
InvalidSubscription	string	Ongeldig abonnement.
InvalidTest	string	Ongeldige test.
InvalidTimeToLive	string	Ongeldige time to live.
InvalidTopForLogs	string	Ongeldige bovenkant voor logboeken.
InvalidTranscription	string	Ongeldige transcriptie.
InvalidWebHookEventKind	string	Ongeldig soort webhook gebeurtenis.
MissingInputRecords	string	Ontbrekende invoerrecords.
ModelCopyOperationExists	string	De kopieerbewerking van het model bestaat.
ModelDeploymentNotCompleteState	string	De status modelimplementatie is niet voltooid.
ModelDeprecated	string	Het model is afgeschaft.
ModelExists	string	Het model bestaat.
ModelMismatch	string	Model komt niet overeen.
ModelNotDeployable	string	Het model kan niet worden geïmplementeerd.
ModelVersionIncorrect	string	Modelversie onjuist.
NoUtf8WithBom	string	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Slechts één van de URL's of container of gegevensset.
ProjectGenderMismatch	string	Het geslacht van het project komt niet overeen.
QuotaViolation	string	Quotumschending.
SingleDefaultEndpoint	string	Eén standaardeindpunt.
SkuLimitsExist	string	Er bestaan SKU-limieten.
SubscriptionNotFound	string	Kan het abonnement niet vinden.
UnexpectedError	string	Onverwachte fout.
UnsupportedClassBasedAdaptation	string	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	string	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	string	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	string	Niet-ondersteund filter.
UnsupportedLanguageCode	string	Niet-ondersteunde taalcode.
UnsupportedOrderBy	string	Niet-ondersteunde bestelling door.
UnsupportedPagination	string	Niet-ondersteunde paginering.
UnsupportedTimeRange	string	Niet-ondersteund tijdsbereik.

DiarizationProperties

Name	Type	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersEigenschappen

DiarizationSpeakersProperties

DiarizationSpeakersEigenschappen

Name	Type	Description
maxCount	integer	Het maximum aantal luidsprekers voor diarisatie. Moet kleiner zijn dan 36 en groter zijn dan of gelijk zijn aan de eigenschap minSpeakers.
minCount	integer	Een hint voor het minimale aantal luidsprekers voor diarisatie. Moet kleiner zijn dan of gelijk zijn aan de eigenschap maxSpeakers.

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

EntityReference

Name	Type	Description
self	string	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

Name	Type	Description
Conflict	string	Vertegenwoordigt de conflictfoutcode.
Forbidden	string	Vertegenwoordigt de verboden foutcode.
InternalCommunicationFailed	string	De foutcode voor de interne communicatie is mislukt.
InternalServerError	string	Vertegenwoordigt de foutcode van de interne serverfout.
InvalidArgument	string	Vertegenwoordigt de foutcode van het ongeldige argument.
InvalidRequest	string	Vertegenwoordigt de ongeldige aanvraagfoutcode.
NotAllowed	string	Vertegenwoordigt de niet-toegestane foutcode.
NotFound	string	Deze vertegenwoordigt de foutcode niet gevonden.
PipelineError	string	Vertegenwoordigt de foutcode van de pijplijnfout.
ServiceUnavailable	string	De foutcode voor de service is niet beschikbaar.
TooManyRequests	string	Vertegenwoordigt de foutcode voor te veel aanvragen.
Unauthorized	string	Vertegenwoordigt de foutcode voor onbevoegden.
UnprocessableEntity	string	Vertegenwoordigt de foutcode van de niet-verwerkbare entiteit.
UnsupportedMediaType	string	Vertegenwoordigt de foutcode van het niet-ondersteunde mediatype.

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.

LanguageIdentificationMode

Name	Type	Description
Continuous	string	Continue taalidentificatie (standaard).
Single	string	Identificatie van één taal.

LanguageIdentificationProperties

Name	Type	Default value	Description
candidateLocales	string[]		De kandidaatlandinstellingen voor taalidentificatie (bijvoorbeeld ["en-US", "de-DE", "es-ES"]). Minimaal 2 en maximaal 10 landinstellingen voor kandidaten, 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 opgegeven voor een landinstelling, wordt het standaardbasismodel gebruikt. Sleutels moeten landinstellingen zijn die zijn opgenomen in de kandidaatlandinstellingen, waarden zijn entiteiten voor modellen van de respectieve landinstellingen.

PaginatedTranscriptions

GepagineerdeTranscripties

Name	Type	Description
@nextLink	string	Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.
values	Transcription[]	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.

Name

Type

Description

@nextLink

string

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

values

Transcription[]

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.

ProfanityFilterMode

Name	Type	Description
Masked	string	Masker de scheldwoorden met * behalve de eerste letter, bijvoorbeeld f***
None	string	Filter op grof taalgebruik uitschakelen.
Removed	string	Verwijder grof taalgebruik.
Tags	string	XML-tags< voor grof taalgebruik/grof taalgebruik toevoegen>

PunctuationMode

Interpunctiemodus

Name	Type	Description
Automatic	string	Automatische interpunctie.
Dictated	string	Alleen gedicteerde interpunctietekens, dat wil zeggen, expliciete interpunctie.
DictatedAndAutomatic	string	Gedicteerde interpunctietekens of automatische interpunctie.
None	string	Geen interpunctie.

Status

Name	Type	Description
Failed	string	De langdurige bewerking is mislukt.
NotStarted	string	De langdurige bewerking is nog niet gestart.
Running	string	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	string	De langdurige bewerking is voltooid.

Transcription

Transcriptie

Name	Type	Description
contentContainerUrl	string	Een URL voor een Azure-blobcontainer die de audiobestanden bevat. Een container mag een maximale grootte van 5 GB en een maximum aantal van 10000 blobs hebben. De maximale grootte voor een blob is 2,5 GB. Container-SAS moet de machtigingen 'r' (lezen) en 'l' (lijst) bevatten. Deze eigenschap wordt niet geretourneerd in een antwoord.
contentUrls	string[]	Een lijst met inhouds-URL's om audiobestanden te transcriberen. Er zijn maximaal 1000 URL's toegestaan. Deze eigenschap wordt niet geretourneerd in een antwoord.
createdDateTime	string	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.
dataset	EntityReference	EntityReference
description	string	De beschrijving van het object.
displayName	string	De weergavenaam van het object.
lastActionDateTime	string	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	TranscriptionLinks	TranscriptionLinks
locale	string	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	TranscriptionProperties
self	string	De locatie van deze entiteit.
status	Status	Status De huidige status van de API beschrijven

TranscriptionLinks

Name	Type	Description
files	string	De locatie voor het ophalen van alle bestanden van deze entiteit. Zie bewerking 'Transcriptions_ListFiles' voor meer informatie.

TranscriptionProperties

Name	Type	Description
channels	integer[]	Een verzameling van de aangevraagde kanaalnummers. In het standaard geval worden de kanalen 0 en 1 in aanmerking genomen.
destinationContainerUrl	string	De aangevraagde doelcontainer. Opmerkingen Wanneer een doelcontainer wordt gebruikt in combinatie met een `timeToLive`, worden de metagegevens van een transcriptie normaal verwijderd, maar de gegevens die zijn opgeslagen in de doelcontainer, inclusief transcriptieresultaten, blijven ongewijzigd, omdat er geen verwijderingsmachtigingen vereist zijn voor deze container. Ter ondersteuning van automatisch opschonen configureert u de levensduur van blobs in de container of gebruikt u 'Bring Your Own Storage (BYOS)' 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 true en het verbeterde diarisatiesysteem wordt geconfigureerd door op te `DiarizationProperties`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 (niet opgeven `DiarizationProperties`), maakt het basisdiarisatiesysteem onderscheid tussen maximaal twee luidsprekers. Er worden geen extra kosten in rekening gebracht voor de basisdiarisatie. Het basisdiarisatiesysteem 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 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
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modus voor het filteren van scheldwoorden.
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 time to live na voltooiing bereikt (geslaagd of mislukt), wordt deze automatisch verwijderd. Als u deze waarde niet instelt of instelt op 0, wordt automatisch verwijderen uitgeschakeld. De langste ondersteunde duur is 31 dagen. De duur is 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`.

Delen via

Projects - List Transcriptions

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Get all transcriptions

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

PaginatedTranscriptions

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Opmerkingen

Aanvullende resources