Transcriptions - Update

Referenz

Dienst:: Azure AI Services

API-Version:: v3.2-preview.2

Aktualisiert die änderbaren Details der durch die ID angegebenen Transkription.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com
id	path	True	string uuid	Der Bezeichner der Transkription.

Anforderungstext

Media Types: "application/json", "application/merge-patch+json"

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Name des Objekts.
project	EntityReference	EntityReference

Antworten

Name	Typ	Beschreibung
200 OK	Transcription	OK Header Retry-After: integer
Other Status Codes	Error	Ein Fehler ist aufgetreten.

Name

Typ

Beschreibung

200 OK

Transcription

Header

Retry-After: integer

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Update a transcription

Beispielanforderung

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683

{
  "displayName": "Updated transcription name",
  "description": "Updated transcription description",
  "customProperties": {
    "key": "value"
  }
}

Beispiel für eine Antwort

Statuscode:: 200

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

Definitionen

Name	Beschreibung
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fehler
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PunctuationMode
Status	Status
Transcription	Transkription
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties
TranscriptionUpdate	TranscriptionUpdate

DetailedErrorCode

Name	Typ	Beschreibung
DataImportFailed	string	Fehler beim Datenimport.
DeleteNotAllowed	string	Löschen nicht zulässig.
DeployNotAllowed	string	Bereitstellen ist nicht zulässig.
DeployingFailedModel	string	Bereitstellen eines fehlerhaften Modells.
EmptyRequest	string	Leere Anforderung.
EndpointCannotBeDefault	string	Der Endpunkt kann nicht standardmäßig sein.
EndpointNotUpdatable	string	Endpunkt nicht aktualisierbar.
EndpointWithoutLogging	string	Endpunkt ohne Protokollierung.
ExceededNumberOfRecordingsUris	string	Die Anzahl der Aufzeichnungs-URIs wurde überschritten.
FailedDataset	string	Fehlgeschlagenes Dataset.
Forbidden	string	Unzulässig.
InUseViolation	string	Bei verwendungsverstößen.
InaccessibleCustomerStorage	string	Auf den Kundenspeicher kann nicht zugegriffen werden.
InvalidAdaptationMapping	string	Ungültige Anpassungszuordnung.
InvalidBaseModel	string	Ungültiges Basismodell.
InvalidCallbackUri	string	Ungültiger Rückruf-URI.
InvalidCollection	string	Ungültige Auflistung.
InvalidDataset	string	Ungültiges Dataset.
InvalidDocument	string	Ungültiges Dokument.
InvalidDocumentBatch	string	Ungültiger Dokumentbatch.
InvalidLocale	string	Ungültiges Gebietsschema.
InvalidLogDate	string	Ungültiges Protokolldatum.
InvalidLogEndTime	string	Ungültige Protokollendzeit.
InvalidLogId	string	Ungültige Protokoll-ID.
InvalidLogStartTime	string	Ungültige Protokollstartzeit.
InvalidModel	string	Ungültiges Modell.
InvalidModelUri	string	Ungültiger Modell-URI.
InvalidParameter	string	Ungültiger Parameter.
InvalidParameterValue	string	Ungültiger Parameterwert.
InvalidPayload	string	Ungültige Nutzlast.
InvalidPermissions	string	Ungültige Berechtigungen.
InvalidPrerequisite	string	Ungültige Voraussetzung.
InvalidProductId	string	Ungültige Produkt-ID.
InvalidProject	string	Ungültiges Projekt.
InvalidProjectKind	string	Ungültige Projektart.
InvalidRecordingsUri	string	Ungültiger Aufzeichnungs-URI.
InvalidRequestBodyFormat	string	Ungültiges Anforderungstextformat.
InvalidSasValidityDuration	string	Ungültige SAS-Gültigkeitsdauer.
InvalidSkipTokenForLogs	string	Ungültiges Überspringen des Tokens für Protokolle.
InvalidSourceAzureResourceId	string	Ungültige Azure-Quellressourcen-ID.
InvalidSubscription	string	Ungültiges Abonnement.
InvalidTest	string	Ungültiger Test.
InvalidTimeToLive	string	Ungültige Gültigkeitsdauer.
InvalidTopForLogs	string	Ungültiger Anfang für Protokolle.
InvalidTranscription	string	Ungültige Transkription.
InvalidWebHookEventKind	string	Ungültige Webhookereignisart.
MissingInputRecords	string	Fehlende Eingabedatensätze.
ModelCopyOperationExists	string	Modellkopiervorgang ist vorhanden.
ModelDeploymentNotCompleteState	string	Der Status der Modellbereitstellung ist nicht abgeschlossen.
ModelDeprecated	string	Das Modell ist veraltet.
ModelExists	string	Das Modell ist vorhanden.
ModelMismatch	string	Modellkonflikt.
ModelNotDeployable	string	Das Modell kann nicht bereitgestellt werden.
ModelVersionIncorrect	string	Modellversion falsch.
NoUtf8WithBom	string	Kein utf8 mit bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Nur eine der URLs, container oder datasets.
ProjectGenderMismatch	string	Projizieren von Geschlechtskonflikten.
QuotaViolation	string	Kontingentverletzung.
SingleDefaultEndpoint	string	Einzelner Standardendpunkt.
SkuLimitsExist	string	SKU-Grenzwerte sind vorhanden.
SubscriptionNotFound	string	Das Abonnement wurde nicht gefunden.
UnexpectedError	string	Unerwarteter Fehler.
UnsupportedClassBasedAdaptation	string	Nicht unterstützte klassenbasierte Anpassung.
UnsupportedDelta	string	Nicht unterstütztes Delta.
UnsupportedDynamicConfiguration	string	Nicht unterstützte dynamische Konfiguration.
UnsupportedFilter	string	Nicht unterstützter Filter.
UnsupportedLanguageCode	string	Nicht unterstützter Sprachcode.
UnsupportedOrderBy	string	Nicht unterstützte Reihenfolge nach.
UnsupportedPagination	string	Nicht unterstützte Paginierung.
UnsupportedTimeRange	string	Nicht unterstützter Zeitbereich.

DiarizationProperties

Name	Typ	Beschreibung
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Name	Typ	Beschreibung
maxCount	integer	Die maximale Anzahl von Sprechern für Diarisierung. Muss kleiner als 36 und größer oder gleich der minSpeakers-Eigenschaft sein.
minCount	integer	Ein Hinweis für die minimale Anzahl von Sprechern für Diarisierung. Muss kleiner oder gleich der maxSpeakers-Eigenschaft sein.

EntityError

Name	Typ	Beschreibung
code	string	Der Code dieses Fehlers.
message	string	Die Meldung für diesen Fehler.

EntityReference

Name	Typ	Beschreibung
self	string	Der Speicherort der Entität, auf die verwiesen wird.

Error

Fehler

Name	Typ	Beschreibung
code	ErrorCode	ErrorCode Allgemeine Fehlercodes.
details	Error[]	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

Name	Typ	Beschreibung
Conflict	string	Stellt den Konfliktfehlercode dar.
Forbidden	string	Stellt den unzulässigen Fehlercode dar.
InternalCommunicationFailed	string	Stellt den Fehlercode für interne Kommunikationsfehler dar.
InternalServerError	string	Stellt den Fehlercode des internen Servers dar.
InvalidArgument	string	Stellt den Fehlercode des ungültigen Arguments dar.
InvalidRequest	string	Stellt den ungültigen Anforderungsfehlercode dar.
NotAllowed	string	Stellt den nicht zulässigen Fehlercode dar.
NotFound	string	Stellt den Fehlercode nicht gefunden dar.
PipelineError	string	Stellt den Fehlercode für die Pipeline dar.
ServiceUnavailable	string	Stellt den Nicht verfügbaren Fehlercode des Diensts dar.
TooManyRequests	string	Stellt den Fehlercode für zu viele Anforderungen dar.
Unauthorized	string	Stellt den nicht autorisierten Fehlercode dar.
UnprocessableEntity	string	Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.
UnsupportedMediaType	string	Stellt den fehlercode für den nicht unterstützten Medientyp dar.

InnerError

Name	Typ	Beschreibung
code	DetailedErrorCode	DetailedErrorCode Detaillierte Fehlercodeenume.
details	object	Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.
innerError	InnerError	InnerError Neues Format für innere Fehler, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar sind. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).
message	string	Allgemeine Fehlermeldung.
target	string	Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

LanguageIdentificationMode

Name	Typ	Beschreibung
Continuous	string	Kontinuierliche Sprachidentifikation (Standard).
Single	string	Identifizierung in einer einzelnen Sprache.

LanguageIdentificationProperties

Name	Typ	Standardwert	Beschreibung
candidateLocales	string[]		Die Kandidatengebietsschemas für die Sprachidentifikation (Beispiel ["en-US", "de-DE", "es-ES"]). Es werden mindestens 2 und maximal 10 Kandidatengebietsschemas unterstützt, einschließlich des Hauptgebietsschemas für die Transkription.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Der für die Sprachidentifizierung verwendete Modus.
speechModelMapping	<string, EntityReference>		Eine optionale Zuordnung von Gebietsschemas zu Sprachmodellentitäten. Wenn für ein Gebietsschema kein Modell angegeben wird, wird das Standardbasismodell verwendet. Schlüssel müssen Gebietsschemas sein, die in den Kandidatengebietsschemas enthalten sind. Werte sind Entitäten für Modelle der jeweiligen Gebietsschemas.

ProfanityFilterMode

Name	Typ	Beschreibung
Masked	string	Maskierung der Obszönitäten mit * mit Ausnahme des ersten Buchstabens, z. B. f***
None	string	Deaktivieren Sie die Anstößigkeitsfilterung.
Removed	string	Entfernen Sie Anstößige.
Tags	string	Hinzufügen von "obszönen" XML-Tags</Anstößigkeit>

PunctuationMode

Name	Typ	Beschreibung
Automatic	string	Automatische Interpunktion.
Dictated	string	Diktierte Interpunktionszeichen, d. h. explizite Interpunktion.
DictatedAndAutomatic	string	Diktierte Interpunktionszeichen oder automatische Interpunktion.
None	string	Keine Interpunktion.

Status

Name	Typ	Beschreibung
Failed	string	Der Vorgang mit langer Ausführungsdauer ist fehlgeschlagen.
NotStarted	string	Der lang andauernde Vorgang wurde noch nicht gestartet.
Running	string	Der Vorgang mit langer Ausführungszeit wird derzeit verarbeitet.
Succeeded	string	Der lang andauernde Vorgang wurde erfolgreich abgeschlossen.

Transcription

Transkription

Name	Typ	Beschreibung
contentContainerUrl	string	Eine URL für einen Azure-Blobcontainer, der die Audiodateien enthält. Ein Container darf eine maximale Größe von 5 GB und eine maximale Anzahl von 10.000 Blobs aufweisen. Die maximale Größe für einen Blob beträgt 2,5 GB. Container-SAS sollte die Berechtigungen "r" (Read) und "l" (List) enthalten. Diese Eigenschaft wird in einer Antwort nicht zurückgegeben.
contentUrls	string[]	Eine Liste von Inhalts-URLs zum Abrufen von Audiodateien, die transkribiert werden sollen. Bis zu 1.000 URLs sind zulässig. Diese Eigenschaft wird in einer Antwort nicht zurückgegeben.
createdDateTime	string	Der Zeitstempel, zu dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
dataset	EntityReference	EntityReference
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Anzeigename des Objekts.
lastActionDateTime	string	Der Zeitstempel, bei dem der aktuelle status eingegeben wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriptionLinks
locale	string	Das Gebietsschema der enthaltenen Daten. Wenn die Sprachidentifikation verwendet wird, wird dieses Gebietsschema verwendet, um Sprache zu transkribieren, für die keine Sprache erkannt werden konnte.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptionProperties
self	string	Der Speicherort dieser Entität.
status	Status	Status Beschreiben des aktuellen Zustands der API

TranscriptionLinks

Name	Typ	Beschreibung
files	string	Der Speicherort, an dem alle Dateien dieser Entität abgerufen werden sollen. Weitere Informationen finden Sie unter Operation "Transcriptions_ListFiles".

TranscriptionProperties

Name	Typ	Beschreibung
channels	integer[]	Eine Sammlung der angeforderten Kanalnummern. Im Standardfall werden die Kanäle 0 und 1 berücksichtigt.
destinationContainerUrl	string	Der angeforderte Zielcontainer. Hinweise Wenn ein Zielcontainer in Kombination mit `timeToLive`verwendet wird, werden die Metadaten einer Transkription normal gelöscht, aber die im Zielcontainer gespeicherten Daten, einschließlich der Transkriptionsergebnisse, bleiben unverändert, da für diesen Container keine Löschberechtigungen erforderlich sind. Um die automatische Bereinigung zu unterstützen, konfigurieren Sie entweder die Bloblebensdauer für den Container, oder verwenden Sie "Bring Your Own Storage (BYOS)" anstelle von `destinationContainerUrl`, wo Blobs bereinigt werden können.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Ein Wert, der angibt, ob eine Diarisierung (Sprecheridentifikation) angefordert wird. Standardwert: `false`. Wenn dieses Feld auf TRUE festgelegt ist und das verbesserte Diarisierungssystem durch Angabe `DiarizationProperties`von konfiguriert wird, stellt das verbesserte Diarisierungssystem diarization für einen konfigurierbaren Lautsprecherbereich bereit. Wenn dieses Feld auf true festgelegt ist und das verbesserte Diarisierungssystem nicht aktiviert ist (ohne Angabe), `DiarizationProperties`unterscheidet das grundlegende Diarisierungssystem zwischen bis zu zwei Lautsprechern. Für die Grundlegende Diarisierung fallen keine zusätzlichen Gebühren an. Das grundlegende Diarisierungssystem ist veraltet und wird in der nächsten Hauptversion der API entfernt. Diese `diarizationEnabled` Einstellung wird ebenfalls entfernt.
displayFormWordLevelTimestampsEnabled	boolean	Ein -Wert, der angibt, ob Zeitstempel auf Wortebene für das Anzeigeformular angefordert werden. Standardwert: `false`.
duration	string	Die Dauer der Transkription. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	Die E-Mail-Adresse, an die E-Mail-Benachrichtigungen gesendet werden sollen, falls der Vorgang abgeschlossen ist. Der Wert wird entfernt, nachdem die E-Mail erfolgreich gesendet wurde.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Art der Anstößigkeitsfilterung.
punctuationMode	PunctuationMode	PunctuationMode Der modus, der für interpunktion verwendet wird.
timeToLive	string	Wie lange die Transkription im System aufbewahrt wird, nachdem sie abgeschlossen ist. Sobald die Transkription die Gültigkeitsdauer nach abschluss erreicht hat (erfolgreich oder fehlgeschlagen), wird sie automatisch gelöscht. Wenn Sie diesen Wert nicht festlegen oder auf 0 festlegen, wird das automatische Löschen deaktiviert. Die längste unterstützte Dauer beträgt 31 Tage. Die Dauer wird als ISO 8601-Dauer codiert ("PnYnMnDTnHnMnS", siehe https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Ein Wert, der angibt, ob Zeitstempel auf Wortebene angefordert werden. Standardwert: `false`.

TranscriptionUpdate

Name	Typ	Beschreibung
customProperties	object	Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge beträgt 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.
description	string	Die Beschreibung des -Objekts.
displayName	string	Der Name des Objekts.
project	EntityReference	EntityReference

Freigeben über

Transcriptions - Update

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Authorization

Beispiele

Update a transcription

Beispielanforderung

Beispiel für eine Antwort

Definitionen

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Hinweise

TranscriptionUpdate

Zusätzliche Ressourcen