Transcriptions - Update

Référence

Service:: Azure AI Services

Version d'API:: 2024-11-15

Met à jour les détails mutables de la transcription identifiée par son ID.

PATCH {endpoint}/speechtotext/transcriptions/{id}?api-version=2024-11-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	Identificateur de la transcription.
api-version	query	True	string	Version de l’API demandée.

En-tête de la demande

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

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string	Fournissez ici votre clé de compte Cognitive Services.

Corps de la demande

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

Nom	Type	Description
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.

Réponses

Nom	Type	Description
200 OK	Transcription	D’ACCORD En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur s’est produite.

Nom

Type

Description

200 OK

Transcription

D’ACCORD

En-têtes

Retry-After: integer

Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

Type: apiKey
Dans: header

Exemples

Update a transcription

Exemple de requête

HTTP

PATCH {endpoint}/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15


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

Exemple de réponse

Code d’état:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  },
  "locale": "en-US",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
  },
  "properties": {
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "timeToLiveHours": 48,
    "durationMilliseconds": 42000
  },
  "status": "Succeeded"
}

Définitions

Nom	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Erreur
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PonctuationMode
Status	Statut
Transcription	Transcription
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties
TranscriptionUpdate	TranscriptionUpdate

DetailedErrorCode

Nom	Type	Description
AudioLengthLimitExceeded	string	Le fichier audio est plus long que la durée maximale autorisée.
BadChannelConfiguration	string	Il existe une incompatibilité entre les canaux audio dans les données, dans la configuration ou les exigences de l’application.
DataImportFailed	string	Échec de l’importation de données.
DeleteNotAllowed	string	Supprimer non autorisé.
DeployNotAllowed	string	Déployer non autorisé.
DeployingFailedModel	string	Déploiement d’un modèle ayant échoué.
EmptyAudioFile	string	Le fichier audio est vide.
EmptyRequest	string	Requête vide.
EndpointCannotBeDefault	string	Le point de terminaison ne peut pas être par défaut.
EndpointLoggingNotSupported	string	La journalisation des points de terminaison n’est pas prise en charge.
EndpointNotUpdatable	string	Point de terminaison non modifiable.
EndpointWithoutLogging	string	Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris	string	Nombre dépassé d’uris d’enregistrement.
FailedDataset	string	Jeu de données ayant échoué.
Forbidden	string	Interdit.
InUseViolation	string	En cas de violation d’utilisation.
InaccessibleCustomerStorage	string	Stockage client inaccessible.
InvalidAdaptationMapping	string	Mappage d’adaptation non valide.
InvalidAudioFormat	string	Le format audio d’entrée n’est pas pris en charge.
InvalidBaseModel	string	Modèle de base non valide.
InvalidCallbackUri	string	URI de rappel non valide.
InvalidChannelSpecification	string	La sélection de canaux dans la demande de transcription n’est pas prise en charge (par exemple, ni 0 ni 1 n’ont été sélectionnés.)
InvalidChannels	string	Canaux non valides.
InvalidCollection	string	Collection non valide.
InvalidDataset	string	Jeu de données non valide.
InvalidDocument	string	Document non valide.
InvalidDocumentBatch	string	Lot de documents non valide.
InvalidLocale	string	Paramètres régionaux non valides.
InvalidLogDate	string	Date de journal non valide.
InvalidLogEndTime	string	Heure de fin du journal non valide.
InvalidLogId	string	ID de journal non valide.
InvalidLogStartTime	string	Heure de début du journal non valide.
InvalidModel	string	Modèle non valide.
InvalidModelUri	string	URI de modèle non valide.
InvalidParameter	string	Paramètre non valide.
InvalidParameterValue	string	Valeur de paramètre non valide.
InvalidPayload	string	Charge utile non valide.
InvalidPermissions	string	Autorisations non valides.
InvalidPrerequisite	string	Prérequis non valides.
InvalidProductId	string	ID de produit non valide.
InvalidProject	string	Projet non valide.
InvalidProjectKind	string	Type de projet non valide.
InvalidRecordingsUri	string	Uri des enregistrements non valides.
InvalidRequestBodyFormat	string	Format du corps de la demande non valide.
InvalidSasValidityDuration	string	Durée de validité de sas non valide.
InvalidSkipTokenForLogs	string	Jeton d’ignorer non valide pour les journaux d’activité.
InvalidSourceAzureResourceId	string	ID de ressource Azure source non valide.
InvalidSubscription	string	Abonnement non valide.
InvalidTest	string	Test non valide.
InvalidTimeToLive	string	Heure de vie non valide.
InvalidTopForLogs	string	Top non valide pour les journaux d’activité.
InvalidTranscription	string	Transcription non valide.
InvalidWebHookEventKind	string	Type d’événement web hook non valide.
MissingInputRecords	string	Enregistrements d’entrée manquants.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization expiré.
ModelDeploymentNotCompleteState	string	Le déploiement du modèle n’est pas terminé.
ModelDeprecated	string	Modèle déconseillé.
ModelExists	string	Le modèle existe.
ModelMismatch	string	Incompatibilité du modèle.
ModelNotDeployable	string	Modèle non déployable.
ModelVersionIncorrect	string	Version du modèle incorrecte.
MultipleLanguagesIdentified	string	L’identification linguistique a reconnu plusieurs langues. Aucune langue dominante ne peut être déterminée.
NoLanguageIdentified	string	L’identification linguistique n’a reconnu aucune langue.
NoUtf8WithBom	string	Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Une seule URL ou conteneur ou jeu de données.
ProjectGenderMismatch	string	Incompatibilité entre les sexes du projet.
QuotaViolation	string	Violation de quota.
SingleDefaultEndpoint	string	Point de terminaison par défaut unique.
SkuLimitsExist	string	Les limites de référence SKU existent.
SubscriptionNotFound	string	Abonnement introuvable.
UnexpectedError	string	Erreur inattendue.
UnsupportedClassBasedAdaptation	string	Adaptation basée sur des classes non prise en charge.
UnsupportedDelta	string	Delta non pris en charge.
UnsupportedDynamicConfiguration	string	Configuration dynamique non prise en charge.
UnsupportedFilter	string	Filtre non pris en charge.
UnsupportedLanguageCode	string	Code de langue non pris en charge.
UnsupportedOrderBy	string	Commande non prise en charge par.
UnsupportedPagination	string	Pagination non prise en charge.
UnsupportedTimeRange	string	Intervalle de temps non pris en charge.

DiarizationProperties

Nom	Type	Description
enabled	boolean	Valeur indiquant si la diarisation de l’orateur est activée.
maxSpeakers	integer	Indicateur du nombre maximal de haut-parleurs pour la diarisation. Doit être supérieur à 1 et inférieur à 36.

EntityError

Nom	Type	Description
code	string	Code de cette erreur.
message	string	Message de cette erreur.

EntityReference

Nom	Type	Description
self	string	Emplacement de l’entité référencée.

Error

Erreur

Nom	Type	Description
code	ErrorCode	ErrorCode Codes d’erreur de haut niveau.
details	Error[]	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

Nom	Type	Description
Conflict	string	Représentant le code d’erreur de conflit.
Forbidden	string	Représentant le code d’erreur interdit.
InternalCommunicationFailed	string	Représentant le code d’erreur de communication interne ayant échoué.
InternalServerError	string	Représentant le code d’erreur du serveur interne.
InvalidArgument	string	Représentant le code d’erreur d’argument non valide.
InvalidRequest	string	Représentant le code d’erreur de requête non valide.
NotAllowed	string	Représentant le code d’erreur non autorisé.
NotFound	string	Représentant le code d’erreur introuvable.
PipelineError	string	Représentant le code d’erreur du pipeline.
ServiceUnavailable	string	Représentant le code d’erreur indisponible du service.
TooManyRequests	string	Représentant le code d’erreur trop grand nombre de requêtes.
Unauthorized	string	Représentant le code d’erreur non autorisé.
UnprocessableEntity	string	Représentant le code d’erreur d’entité non traité.
UnsupportedMediaType	string	Représentant le code d’erreur du type de média non pris en charge.

InnerError

Nom	Type	Description
code	DetailedErrorCode	DetailedErrorCode Énumération détaillée du code d’erreur.
details	object	Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError	InnerError	InnerError Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

LanguageIdentificationMode

Nom	Type	Description
Continuous	string	Identification continue du langage (valeur par défaut).
Single	string	Identification de langue unique. Si aucune langue ne peut être identifiée, le code d’erreur NoLanguage Identified est retourné à l’utilisateur. S’il existe une ambiguïté entre plusieurs langues, le code d’erreur MultipleLanguagesIdentified est retourné à l’utilisateur.

LanguageIdentificationProperties

Nom	Type	Valeur par défaut	Description
candidateLocales	string[]		Paramètres régionaux candidats pour l’identification linguistique (exemple [ »en-US« , "de-DE« , "es-ES« ]). Au moins 2 et un maximum de 10 paramètres régionaux candidats, y compris les paramètres régionaux principaux de la transcription, sont pris en charge pour le mode continu. Pour l’identification de langue unique, le nombre maximal de paramètres régionaux candidats n’est pas lié.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode Mode utilisé pour l’identification de la langue.
speechModelMapping	<string, EntityReference>		Mappage facultatif des paramètres régionaux aux entités du modèle speech. Si aucun modèle n’est donné pour des paramètres régionaux, le modèle de base par défaut est utilisé. Les clés doivent être des paramètres régionaux contenus dans les paramètres régionaux candidats, les valeurs sont des entités pour les modèles des paramètres régionaux respectifs.

ProfanityFilterMode

Nom	Type	Description
Masked	string	Masquer la profanité avec * à l’exception de la première lettre, par exemple, f***
None	string	Désactivez le filtrage des profanités.
Removed	string	Supprimez la profanité.
Tags	string	Ajouter des balises XML « profanity »</Profanity>

PunctuationMode

PonctuationMode

Nom	Type	Description
Automatic	string	Ponctuation automatique.
Dictated	string	Signes de ponctuation dictés uniquement, c’est-à-dire ponctuation explicite.
DictatedAndAutomatic	string	Signes de ponctuation dictés ou ponctuation automatique.
None	string	Pas de ponctuation.

Status

Statut

Nom	Type	Description
Failed	string	L’opération de longue durée a échoué.
NotStarted	string	L’opération de longue durée n’a pas encore démarré.
Running	string	L’opération de longue durée est en cours de traitement.
Succeeded	string	L’opération de longue durée s’est terminée.

Transcription

Nom	Type	Description
contentContainerUrl	string	URL d’un conteneur d’objets blob Azure qui contient les fichiers audio. Un conteneur est autorisé à avoir une taille maximale de 5 Go et un nombre maximal de 1 0000 objets blob. La taille maximale d’un objet blob est de 2,5 Go. La SIGNATURE d’accès partagé du conteneur doit contenir des autorisations « r » (lecture) et « l » (liste). Cette propriété ne sera pas retournée dans une réponse.
contentUrls	string[]	Liste des URL de contenu pour obtenir des fichiers audio à transcrire. Jusqu’à 1 000 URL sont autorisées. Cette propriété ne sera pas retournée dans une réponse.
createdDateTime	string	Horodatage de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
dataset	EntityReference	EntityReference
description	string	Description de l’objet.
displayName	string	Nom complet de l’objet.
lastActionDateTime	string	Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriptionLinks
locale	string	Paramètres régionaux des données contenues. Si l’identification de la langue est utilisée, ces paramètres régionaux sont utilisés pour transcrire la parole pour laquelle aucune langue n’a pu être détectée.
model	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptionProperties
self	string	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API.

TranscriptionLinks

Nom	Type	Description
files	string	Emplacement pour obtenir tous les fichiers de cette entité. Pour plus d’informations, consultez l’opération « Transcriptions_ListFiles ».

TranscriptionProperties

Nom	Type	Valeur par défaut	Description
channels	integer[]		Collection des numéros de canal demandés. Dans le cas par défaut, les canaux 0 et 1 sont pris en compte.
destinationContainerUrl	string		Conteneur de destination demandé. Remarques Lorsqu’un conteneur de destination est utilisé en combinaison avec un `timeToLive`, les métadonnées d’une transcription sont supprimées normalement, mais les données stockées dans le conteneur de destination, y compris les résultats de transcription, restent inchangées, car aucune autorisation de suppression n’est requise pour ce conteneur. Pour prendre en charge le nettoyage automatique, configurez les durées de vie des objets blob sur le conteneur ou utilisez « Bring your own Storage (BYOS) » au lieu de `destinationContainerUrl`, où les objets blob peuvent être nettoyés.
diarization	DiarizationProperties		DiarizationProperties
displayFormWordLevelTimestampsEnabled	boolean		Valeur indiquant si les horodatages au niveau du mot pour le formulaire d’affichage sont demandés. La valeur par défaut est `false`.
durationMilliseconds	integer	0	Durée en millisecondes de la transcription. Les durées supérieures à 2^53-1 ne sont pas prises en charge pour garantir la compatibilité avec les entiers JavaScript.
error	EntityError		EntityError
languageIdentification	LanguageIdentificationProperties		LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode		ProfanityFilterMode Mode de filtrage des profanités.
punctuationMode	PunctuationMode		PonctuationMode Mode utilisé pour la ponctuation.
timeToLiveHours	integer		Durée pendant laquelle la transcription sera conservée dans le système une fois terminée. Une fois la transcription terminée(réussie ou ayant échoué), la transcription sera automatiquement supprimée. Remarque : lors de l’utilisation de BYOS (apportez votre propre stockage), les fichiers de résultats sur le compte de stockage appartenant au client seront également supprimés. Utilisez destinationContainerUrl pour spécifier un conteneur distinct pour les fichiers de résultats qui ne seront pas supprimés lorsque timeToLive expire, ou récupérez les fichiers de résultats via l’API et stockez-les en fonction des besoins. La durée prise en charge la plus courte est de 6 heures, la durée la plus longue prise en charge est de 31 jours. 2 jours (48 heures) est la valeur par défaut recommandée lorsque les données sont consommées directement.
wordLevelTimestampsEnabled	boolean		Valeur indiquant si les horodatages au niveau du mot sont demandés. La valeur par défaut est `false`.

TranscriptionUpdate

Nom	Type	Description
customProperties	object	Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description	string	Description de l’objet.
displayName	string	Nom de l’objet.

Partager via

Transcriptions - Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Update a transcription

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

DiarizationProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Remarques

TranscriptionUpdate

Ressources supplémentaires