Transcriptions - Update

Référence

Service:: Azure AI Services

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

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

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

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.

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 autorisée de la clé 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.
project	EntityReference	EntityReference

Réponses

Nom	Type	Description
200 OK	Transcription	Ok En-têtes Retry-After: integer
Other Status Codes	Error	Une erreur est survenue.

Nom

Type

Description

200 OK

Transcription

En-têtes

Retry-After: integer

Other Status Codes

Error

Une erreur est survenue.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez la clé de votre compte Cognitive Services ici.

Type: apiKey
Dans: header

Authorization

Fournissez un jeton d’accès à partir du JWT retourné par le STS de cette région. Veillez à ajouter l’étendue de gestion au jeton en ajoutant la chaîne de requête suivante à l’URL STS : ?scope=speechservicesmanagement

Type: apiKey
Dans: header

Exemples

Update a transcription

Exemple de requête

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

Exemple de réponse

Code d’état:: 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"
  }
}

Définitions

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

DetailedErrorCode

Nom	Type	Description
DataImportFailed	string	Échec de l’importation des données.
DeleteNotAllowed	string	Suppression non autorisée.
DeployNotAllowed	string	Déploiement non autorisé.
DeployingFailedModel	string	Déploiement d’un modèle ayant échoué.
EmptyRequest	string	Requête vide.
EndpointCannotBeDefault	string	Le point de terminaison ne peut pas être par défaut.
EndpointNotUpdatable	string	Point de terminaison non modifiable.
EndpointWithoutLogging	string	Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris	string	Nombre d’URI d’enregistrements dépassé.
FailedDataset	string	Échec du jeu de données.
Forbidden	string	Interdit.
InUseViolation	string	Violation en cours d’utilisation.
InaccessibleCustomerStorage	string	Stockage client inaccessible.
InvalidAdaptationMapping	string	Mappage d’adaptation non valide.
InvalidBaseModel	string	Modèle de base non valide.
InvalidCallbackUri	string	URI de rappel non valide.
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’évitement non valide pour les journaux.
InvalidSourceAzureResourceId	string	ID de ressource Azure source non valide.
InvalidSubscription	string	Abonnement non valide.
InvalidTest	string	Test non valide.
InvalidTimeToLive	string	Durée de vie non valide.
InvalidTopForLogs	string	Haut non valide pour les journaux.
InvalidTranscription	string	Transcription non valide.
InvalidWebHookEventKind	string	Type d’événement web hook non valide.
MissingInputRecords	string	Enregistrements d’entrée manquants.
ModelCopyOperationExists	string	L’opération de copie de modèle existe.
ModelDeploymentNotCompleteState	string	État non terminé du déploiement du modèle.
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.
NoUtf8WithBom	string	Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Une seule des URL, conteneur ou jeu de données.
ProjectGenderMismatch	string	Projet d’incompatibilité entre les sexes.
QuotaViolation	string	Violation de quota.
SingleDefaultEndpoint	string	Point de terminaison par défaut unique.
SkuLimitsExist	string	Il existe des limites de référence SKU.
SubscriptionNotFound	string	Abonnement introuvable.
UnexpectedError	string	Erreur inattendue.
UnsupportedClassBasedAdaptation	string	Adaptation basée sur les 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
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Nom	Type	Description
maxCount	integer	Nombre maximal de haut-parleurs pour la diarisation. Doit être inférieur à 36 et supérieur ou égal à la propriété minSpeakers.
minCount	integer	Indicateur du nombre minimal de haut-parleurs pour la diarisation. Doit être inférieur ou égal à la propriété maxSpeakers.

EntityError

Nom	Type	Description
code	string	Code de cette erreur.
message	string	Message correspondant à 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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un 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 d’échec de la communication interne.
InternalServerError	string	Représentant le code d’erreur interne du serveur.
InvalidArgument	string	Représentant le code d’erreur de l’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, disponible à l’adresse https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ce format contient les propriétés obligatoires ErrorCode, message et les propriétés facultatives target, details (paire clé-valeur), et l’erreur interne (qui peut être imbriquée).
message	string	Message d’erreur de haut niveau.
target	string	Source de l’erreur. Par exemple, « documents » ou « document id » en présence d’un document non valide.

LanguageIdentificationMode

Nom	Type	Description
Continuous	string	Identification continue de la langue (par défaut).
Single	string	Identification d’une seule langue.

LanguageIdentificationProperties

Nom	Type	Valeur par défaut	Description
candidateLocales	string[]		Paramètres régionaux candidats pour l’identification de la langue (exemple ["en-US », « de-DE », « es-ES"]). Un minimum de 2 et un maximum de 10 paramètres régionaux candidats, y compris les paramètres régionaux principaux pour la transcription, sont pris en charge.
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 de modèle speech. Si aucun modèle n’est fourni pour un paramètre régional, 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	Masquez les blasphèmes avec * à l’exception de la première lettre, par exemple, f***
None	string	Désactivez le filtrage des blasphèmes.
Removed	string	Supprimez les blasphèmes.
Tags	string	Ajouter des balises XML « blasphèmes< » /Blasphème>

PunctuationMode

Nom	Type	Description
Automatic	string	Ponctuation automatique.
Dictated	string	Signes de ponctuation dictés uniquement, c’est-à-dire une ponctuation explicite.
DictatedAndAutomatic	string	Signes de ponctuation dictés ou ponctuation automatique.
None	string	Aucune 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 avec succès.

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 10 000 objets blob. La taille maximale d'un objet blob est de 2,5 Go. La signature d’accès partagé de conteneur doit contenir les autorisations « r » (lecture) et « l » (liste). Cette propriété n’est 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é n’est pas retournée dans une réponse.
createdDateTime	string	Horodatage de la création de l’objet. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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 autorisée de la clé 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 le status actuel a été entré. L’horodatage est encodé au format de date et d’heure ISO 8601 (« AAAA-MM-JJThh :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 les paroles pour lesquelles aucune langue n’a pu être détectée.
model	EntityReference	EntityReference
project	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	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 normalement supprimées, mais les données stockées dans le conteneur de destination, y compris les résultats de la 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 « Apportez votre propre stockage (BYOS) » au lieu de `destinationContainerUrl`, où les objets blob peuvent être nettoyés.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Valeur indiquant si la diarisation (identification de l’orateur) est demandée. La valeur par défaut est `false`. Si ce champ est défini sur true et que le système de diarisation amélioré est configuré en spécifiant `DiarizationProperties`, le système de diarisation amélioré fournit la diarisation pour une plage configurable de haut-parleurs. Si ce champ est défini sur true et que le système de diarisation amélioré n’est pas activé (sans spécifier `DiarizationProperties`), le système de diarisation de base fait la distinction entre jusqu’à deux haut-parleurs. Aucun frais supplémentaire n’est appliqué pour la diarisation de base. Le système de diarisation de base est déprécié et sera supprimé dans la prochaine version majeure de l’API. Ce `diarizationEnabled` paramètre sera également supprimé.
displayFormWordLevelTimestampsEnabled	boolean	Valeur indiquant si des horodatages au niveau du mot pour le formulaire d’affichage sont demandés. La valeur par défaut est `false`.
duration	string	Durée de la transcription. La durée est encodée en tant que durée ISO 8601 (« PnYnMnDTnHnMnS », voir https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	Adresse e-mail à laquelle envoyer Notifications par e-mail au cas où l’opération se termine. La valeur sera supprimée après l’envoi de l’e-mail.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Mode de filtrage des blasphèmes.
punctuationMode	PunctuationMode	PunctuationMode Mode utilisé pour la ponctuation.
timeToLive	string	Durée pendant laquelle la transcription sera conservée dans le système une fois celle-ci terminée. Une fois que la transcription atteint le temps de vie après l’achèvement (réussite ou échec), elle est automatiquement supprimée. Le fait de ne pas définir cette valeur ou de la définir sur 0 désactive la suppression automatique. La plus longue durée prise en charge est de 31 jours. La durée est encodée en tant que durée ISO 8601 (« PnYnMnDTnHnMnS », voir https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Valeur indiquant si des 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 autorisée de la clé 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.
project	EntityReference	EntityReference

Partager via

Transcriptions - Update

Paramètres URI

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Authorization

Exemples

Update a transcription

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Remarques

TranscriptionUpdate

Ressources supplémentaires