Transcriptions - List

Référence

Service:: Azure AI Services

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

Obtient une liste de transcriptions pour l’abonnement authentifié.

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

Avec des paramètres facultatifs:

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip={skip}&top={top}&filter={filter}

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).
filter	query		string	Expression de filtrage permettant de sélectionner un sous-ensemble des transcriptions disponibles. `- 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)	Nombre de jeux de données ignorés.
top	query		integer (int32)	Nombre de jeux de données qui seront inclus après l’ignorer.

Réponses

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

Nom

Type

Description

200 OK

PaginatedTranscriptions

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

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

Get all failed transcriptions

Get all transcriptions

Get all failed transcriptions

Exemple de requête

HTTP

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

Exemple de réponse

Code d’état:: 200

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

Exemple de requête

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Exemple de réponse

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

Définitions

Nom	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Erreur
ErrorCode	Code d'erreur
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
PaginatedTranscriptions	PaginédTranscriptions
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PonctuationMode
Status	Statut
Transcription	Transcription
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties

DetailedErrorCode

Énumération

DetailedErrorCode

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

DiarizationProperties

Object

DiarizationProperties

Nom	Type	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Object

DiarizationSpeakersProperties

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

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

Error

Object

Erreur

Nom	Type	Description
code	ErrorCode	Code d'erreur 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

Énumération

Code d'erreur

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

InnerError

Object

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

Énumération

LanguageIdentificationMode

Valeur	Description
Continuous	Identification continue du langage (valeur par défaut).
Single	Identification de langue unique.

LanguageIdentificationProperties

Object

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« ]). Un minimum de 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.
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.

PaginatedTranscriptions

Object

PaginédTranscriptions

Nom	Type	Description
@nextLink	string (uri)	Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.
values	Transcription[]	Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut. Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

Nom

Type

Description

@nextLink

string (uri)

Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.

values

Transcription[]

Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut.

Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

ProfanityFilterMode

Énumération

ProfanityFilterMode

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

PunctuationMode

Énumération

PonctuationMode

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

Status

Énumération

Statut

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

Transcription

Object

Transcription

Nom	Type	Description
contentContainerUrl	string (uri)	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[] (uri)	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 (date-time)	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 minLength: 1	Nom complet de l’objet.
lastActionDateTime	string (date-time)	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 minLength: 1	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
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptionProperties
self	string (uri)	Emplacement de cette entité.
status	Status	Statut Décrire l’état actuel de l’API

TranscriptionLinks

Object

TranscriptionLinks

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

TranscriptionProperties

Object

TranscriptionProperties

Nom	Type	Description
channels	integer[] (int32)	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 (uri)	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
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é fournira la diarisation pour une plage configurable d’orateurs. Si ce champ est défini sur true et que le système de diarisation amélioré n’est pas activé (ne spécifiant pas `DiarizationProperties`), le système de diarisation de base fait la distinction entre deux haut-parleurs. Aucun frais supplémentaire n’est appliqué pour la diarisation de base. Le système de diarisation de base est déconseillé et sera supprimé dans la prochaine version majeure de l’API. Ce paramètre `diarizationEnabled` sera également supprimé.
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`.
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 des notifications par e-mail au cas où l’opération se termine. La valeur est supprimée après l’envoi de l’e-mail.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Mode de filtrage des profanités.
punctuationMode	PunctuationMode	PonctuationMode Mode utilisé pour la ponctuation.
timeToLive	string	Durée pendant laquelle la transcription sera conservée dans le système une fois terminée. Une fois que la transcription atteint la durée de vie après l’achèvement (réussie ou ayant échoué), elle est automatiquement supprimée. Ne pas définir cette valeur ou la définir sur 0 désactive la suppression automatique. La durée la plus longue 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 les horodatages au niveau du mot sont demandés. La valeur par défaut est `false`.

Partager via

Transcriptions - List

Paramètres URI

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Authorization

Exemples

Get all failed transcriptions

Exemple de requête

Exemple de réponse

Get all transcriptions

Exemple de requête

Exemple de réponse

Définitions

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

PaginatedTranscriptions

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Remarques

Ressources supplémentaires