Condividi tramite

Transcriptions - List

  • Riferimento
Servizio:
Azure AI Services
Versione API:
v3.2-preview.2

Ottiene un elenco di trascrizioni per la sottoscrizione autenticata.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
 path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://westus.api.cognitive.microsoft.com).
filter
 query

string

Espressione di filtro per la selezione di un subset delle trascrizioni disponibili.

        - 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)

Numero di set di dati che verranno ignorati.
top
 query

integer (int32)

Numero di set di dati che verranno inclusi dopo aver ignorato.

Risposte

Nome Tipo Descrizione
200 OK

PaginatedTranscriptions

Va bene

Intestazioni

Retry-After: integer
Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave dell'account di Servizi cognitivi qui.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal token JWT restituito dal servizio token di sicurezza di questa area. Assicurarsi di aggiungere l'ambito di gestione al token aggiungendo la stringa di query seguente all'URL sts: ?scope=speechservicesmanagement

Tipo: apiKey
In: header

Esempio

Get all failed transcriptions
Get all transcriptions

Get all failed transcriptions

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
}

Definizioni

Nome Descrizione
DetailedErrorCode

DetailedErrorCode
DiarizationProperties

Proprietà diarizzazione
DiarizationSpeakersProperties

DiarizationSpeakersProperties
EntityError

EntityError
EntityReference

EntityReference
Error

Errore
ErrorCode

Codice Errore
InnerError

InnerError
LanguageIdentificationMode

LanguageIdentificationMode
LanguageIdentificationProperties

LanguageIdentificationProperties
PaginatedTranscriptions

PaginatedTranscriptions
ProfanityFilterMode

ProfanityFilterMode
PunctuationMode

PunctuationMode
Status

Stato
Transcription

Trascrizione
TranscriptionLinks

TranscriptionLinks
TranscriptionProperties

Proprietà di trascrizione

DetailedErrorCode

Enumerazione

DetailedErrorCode

Valore Descrizione
DataImportFailed

Importazione dei dati non riuscita.
DeleteNotAllowed

Eliminazione non consentita.
DeployNotAllowed

Distribuzione non consentita.
DeployingFailedModel

Distribuzione del modello non riuscito.
EmptyRequest

Richiesta vuota.
EndpointCannotBeDefault

L'endpoint non può essere predefinito.
EndpointNotUpdatable

Endpoint non aggiornabile.
EndpointWithoutLogging

Endpoint senza registrazione.
ExceededNumberOfRecordingsUris

È stato superato il numero di URI delle registrazioni.
FailedDataset

Set di dati non riuscito.
Forbidden

Vietato.
InUseViolation

In violazione dell'uso.
InaccessibleCustomerStorage

Archiviazione dei clienti inaccessibile.
InvalidAdaptationMapping

Mapping di adattamento non valido.
InvalidBaseModel

Modello di base non valido.
InvalidCallbackUri

URI di callback non valido.
InvalidCollection

Raccolta non valida.
InvalidDataset

Set di dati non valido.
InvalidDocument

Documento non valido.
InvalidDocumentBatch

Batch di documenti non valido.
InvalidLocale

Impostazioni locali non valide.
InvalidLogDate

Data del log non valida.
InvalidLogEndTime

Ora di fine del log non valida.
InvalidLogId

ID log non valido.
InvalidLogStartTime

Ora di inizio del log non valida.
InvalidModel

Modello non valido.
InvalidModelUri

URI del modello non valido.
InvalidParameter

Parametro non valido.
InvalidParameterValue

Valore del parametro non valido.
InvalidPayload

Payload non valido.
InvalidPermissions

Autorizzazioni non valide.
InvalidPrerequisite

Prerequisito non valido.
InvalidProductId

ID prodotto non valido.
InvalidProject

Progetto non valido.
InvalidProjectKind

Tipo di progetto non valido.
InvalidRecordingsUri

URI delle registrazioni non valido.
InvalidRequestBodyFormat

Formato del corpo della richiesta non valido.
InvalidSasValidityDuration

Durata della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs

Token skip non valido per i log.
InvalidSourceAzureResourceId

ID risorsa di Azure di origine non valido.
InvalidSubscription

Sottoscrizione non valida.
InvalidTest

Test non valido.
InvalidTimeToLive

Tempo di vita non valido.
InvalidTopForLogs

Top non valido per i log.
InvalidTranscription

Trascrizione non valida.
InvalidWebHookEventKind

Tipo di evento web hook non valido.
MissingInputRecords

Record di input mancanti.
ModelCopyOperationExists

Esiste un'operazione di copia del modello.
ModelDeploymentNotCompleteState

Lo stato della distribuzione del modello non è completo.
ModelDeprecated

Modello deprecato.
ModelExists

Il modello esiste.
ModelMismatch

Mancata corrispondenza del modello.
ModelNotDeployable

Modello non distribuibile.
ModelVersionIncorrect

Versione del modello non corretta.
NoUtf8WithBom

Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset

Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch

Mancata corrispondenza di genere del progetto.
QuotaViolation

Violazione della quota.
SingleDefaultEndpoint

Singolo endpoint predefinito.
SkuLimitsExist

Esistono limiti di SKU.
SubscriptionNotFound

Sottoscrizione non trovata.
UnexpectedError

Errore imprevisto.
UnsupportedClassBasedAdaptation

Adattamento basato su classe non supportato.
UnsupportedDelta

Delta non supportato.
UnsupportedDynamicConfiguration

Configurazione dinamica non supportata.
UnsupportedFilter

Filtro non supportato.
UnsupportedLanguageCode

Codice del linguaggio non supportato.
UnsupportedOrderBy

Ordine non supportato per.
UnsupportedPagination

Impaginazione non supportata.
UnsupportedTimeRange

Intervallo di tempo non supportato.

DiarizationProperties

Object

Proprietà diarizzazione

Nome Tipo Descrizione
speakers

DiarizationSpeakersProperties

DiarizationSpeakersProperties

DiarizationSpeakersProperties

Object

DiarizationSpeakersProperties

Nome Tipo Descrizione
maxCount

integer (int32)

minimum: 1

Numero massimo di altoparlanti per la diarizzazione. Deve essere minore di 36 e maggiore o uguale alla proprietà minSpeakers.
minCount

integer (int32)

minimum: 1

Suggerimento per il numero minimo di altoparlanti per la diarizzazione. Deve essere minore o uguale alla proprietà maxSpeakers.

EntityError

Object

EntityError

Nome Tipo Descrizione
code

string

Codice di questo errore.
message

string

Messaggio per questo errore.

EntityReference

Object

EntityReference

Nome Tipo Descrizione
self

string (uri)

Posizione dell'entità a cui si fa riferimento.

Error

Object

Errore

Nome Tipo Descrizione
code

ErrorCode

Codice Errore
Codici di errore di alto livello.
details

Error[]

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

ErrorCode

Enumerazione

Codice Errore

Valore Descrizione
Conflict

Rappresentazione del codice di errore del conflitto.
Forbidden

Rappresentazione del codice di errore non consentito.
InternalCommunicationFailed

Rappresentazione del codice di errore della comunicazione interna non riuscita.
InternalServerError

Rappresentazione del codice di errore interno del server.
InvalidArgument

Rappresentazione del codice di errore dell'argomento non valido.
InvalidRequest

Rappresentazione del codice di errore della richiesta non valido.
NotAllowed

Rappresentazione del codice di errore non consentito.
NotFound

Rappresentazione del codice di errore non trovato.
PipelineError

Rappresentazione del codice di errore della pipeline.
ServiceUnavailable

Rappresentazione del codice di errore del servizio non disponibile.
TooManyRequests

Rappresentazione del codice di errore troppe richieste.
Unauthorized

Rappresentazione del codice di errore non autorizzato.
UnprocessableEntity

Rappresentazione del codice di errore dell'entità non elaborabile.
UnsupportedMediaType

Rappresentazione del codice di errore del tipo di supporto non supportato.

InnerError

Object

InnerError

Nome Tipo Descrizione
code

DetailedErrorCode

DetailedErrorCode
Enumerazione dettagliata del codice di errore.
details

object

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innerError

InnerError

InnerError
Nuovo formato di errore interno conforme alle linee guida dell'API Servizi cognitivi, disponibile in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene le proprietà obbligatorie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia chiave-valore), errore interno (che può essere annidato).
message

string

Messaggio di errore di alto livello.
target

string

Indica l'origine dell'errore. Ad esempio, si tratta di "documenti" o "ID documento" in caso di documento non valido.

LanguageIdentificationMode

Enumerazione

LanguageIdentificationMode

Valore Descrizione
Continuous

Identificazione continua della lingua (impostazione predefinita).
Single

Identificazione di una sola lingua.

LanguageIdentificationProperties

Object

LanguageIdentificationProperties

Nome Tipo Valore predefinito Descrizione
candidateLocales

string[]

Impostazioni locali candidate per l'identificazione della lingua (ad esempio ["en-US", "de-DE", "es-ES"]). È supportato almeno 2 e un massimo di 10 impostazioni locali candidate, incluse le impostazioni locali principali per la trascrizione.
mode

LanguageIdentificationMode

Continuous

LanguageIdentificationMode
Modalità utilizzata per l'identificazione della lingua.
speechModelMapping

<string,  EntityReference>

Mapping facoltativo delle impostazioni locali alle entità del modello di riconoscimento vocale. Se non viene specificato alcun modello per le impostazioni locali, viene usato il modello di base predefinito. Le chiavi devono essere impostazioni locali contenute nelle impostazioni locali candidate, i valori sono entità per i modelli delle rispettive impostazioni locali.

PaginatedTranscriptions

Object

PaginatedTranscriptions

Nome Tipo Descrizione
@nextLink

string (uri)

Collegamento al set successivo di risultati impaginati se sono disponibili più entità; in caso contrario null.
values

Transcription[]

Elenco di entità limitate dai parametri di query passati 'skip' e 'top' o dai relativi valori predefiniti.

Quando si esegue l'iterazione di un elenco usando la paginazione e l'eliminazione di entità in parallelo, alcune entità verranno ignorate nei risultati. È consigliabile compilare un elenco nel client ed eliminarlo dopo il recupero dell'elenco completo.

ProfanityFilterMode

Enumerazione

ProfanityFilterMode

Valore Descrizione
Masked

Mascherare il contenuto volgare con * tranne la prima lettera, ad esempio f**
None

Disabilitare il filtro per il contenuto volgare.
Removed

Rimuovere il contenuto volgare.
Tags

Aggiungere tag XML "volgarity"</Profanity>

PunctuationMode

Enumerazione

PunctuationMode

Valore Descrizione
Automatic

Punteggiatura automatica.
Dictated

Segni di punteggiatura dettati solo, ad esempio la punteggiatura esplicita.
DictatedAndAutomatic

Segni di punteggiatura dettati o punteggiatura automatica.
None

Nessuna punteggiatura.

Status

Enumerazione

Stato

Valore Descrizione
Failed

L'operazione a esecuzione prolungata non è riuscita.
NotStarted

L'operazione a esecuzione prolungata non è ancora stata avviata.
Running

L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded

L'operazione a esecuzione prolungata è stata completata correttamente.

Transcription

Object

Trascrizione

Nome Tipo Descrizione
contentContainerUrl

string (uri)

URL per un contenitore BLOB di Azure che contiene i file audio. Un contenitore può avere una dimensione massima di 5 GB e un numero massimo di 10000 BLOB. La dimensione massima per un BLOB è di 2,5 GB. La firma di accesso condiviso del contenitore deve contenere autorizzazioni 'r' (lettura) e 'l' (elenco). Questa proprietà non verrà restituita in una risposta.
contentUrls

string[] (uri)

Elenco di URL di contenuto per ottenere file audio da trascrivere. Sono consentiti fino a 1000 URL. Questa proprietà non verrà restituita in una risposta.
createdDateTime

string (date-time)

Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita del valore è di 256 caratteri e il numero di voci consentite è 10.
dataset

EntityReference

EntityReference
description

string

Descrizione dell'oggetto.
displayName

string

minLength: 1

Nome visualizzato dell'oggetto.
lastActionDateTime

string (date-time)

Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

TranscriptionLinks

TranscriptionLinks
locale

string

minLength: 1

Impostazioni locali dei dati contenuti. Se viene usata l'identificazione della lingua, queste impostazioni locali vengono usate per trascrivere il parlato per il quale non è possibile rilevare alcuna lingua.
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

TranscriptionProperties

Proprietà di trascrizione
self

string (uri)

Posizione dell'entità.
status

Status

Stato
Descrivere lo stato corrente dell'API
Object

TranscriptionLinks

Nome Tipo Descrizione
files

string (uri)

Percorso in cui ottenere tutti i file di questa entità. Per altri dettagli, vedere l'operazione "Transcriptions_ListFiles".

TranscriptionProperties

Object

Proprietà di trascrizione

Nome Tipo Descrizione
channels

integer[] (int32)

Raccolta dei numeri di canale richiesti. Nel caso predefinito, vengono considerati i canali 0 e 1.
destinationContainerUrl

string (uri)

Contenitore di destinazione richiesto.

Osservazioni:

Quando un contenitore di destinazione viene usato in combinazione con un timeToLive, i metadati di una trascrizione verranno eliminati normalmente, ma i dati archiviati nel contenitore di destinazione, inclusi i risultati della trascrizione, rimarranno invariati, perché non sono necessarie autorizzazioni di eliminazione per questo contenitore.
Per supportare la pulizia automatica, configurare la durata dei BLOB nel contenitore o usare "Bring Your Own Storage (BYOS)" invece di destinationContainerUrl, in cui è possibile pulire i BLOB.
diarization

DiarizationProperties

Proprietà diarizzazione
diarizationEnabled

boolean

Valore che indica se è richiesta la diarizzazione (identificazione voce). Il valore predefinito è false. Se questo campo è impostato su true e il sistema di diarizzazione migliorato è configurato specificando DiarizationProperties, il sistema di diarizzazione migliorato fornirà la diarizzazione per un intervallo configurabile di altoparlanti. Se questo campo è impostato su true e il sistema di diarizzazione migliorato non è abilitato (non specificando DiarizationProperties), il sistema di diarizzazione di base distinguerà tra un massimo di due altoparlanti. Non vengono applicati addebiti aggiuntivi per la diarizzazione di base.

Il sistema di diarizzazione di base è deprecato e verrà rimosso nella prossima versione principale dell'API. Questa impostazione diarizationEnabled verrà rimossa anche.
displayFormWordLevelTimestampsEnabled

boolean

Valore che indica se vengono richiesti timestamp a livello di parola per il modulo di visualizzazione. Il valore predefinito è false.
duration

string

Durata della trascrizione. La durata viene codificata come durata ISO 8601 ("PnYnMnDTnHnMnS", vedere https://en.wikipedia.org/wiki/ISO_8601#Durations).
email

string

Indirizzo di posta elettronica a cui inviare notifiche tramite posta elettronica nel caso in cui l'operazione venga completata. Il valore verrà rimosso dopo l'invio corretto del messaggio di posta elettronica.
error

EntityError

EntityError
languageIdentification

LanguageIdentificationProperties

LanguageIdentificationProperties
profanityFilterMode

ProfanityFilterMode

ProfanityFilterMode
Modalità di filtro per il contenuto volgare.
punctuationMode

PunctuationMode

PunctuationMode
Modalità utilizzata per la punteggiatura.
timeToLive

string

Per quanto tempo la trascrizione verrà mantenuta nel sistema dopo il completamento. Una volta raggiunta la durata della trascrizione dopo il completamento (esito positivo o negativo), la trascrizione verrà eliminata automaticamente. Non impostando questo valore o impostandolo su 0, l'eliminazione automatica verrà disabilitata. La durata supportata più lunga è di 31 giorni. La durata viene codificata come durata ISO 8601 ("PnYnMnDTnHnMnS", vedere https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled

boolean

Valore che indica se vengono richiesti timestamp a livello di parola. Il valore predefinito è false.