Transcriptions - Update

Riferimento

Servizio:: Azure AI Services

Versione API:: 3.2

Aggiorna i dettagli modificabili della trascrizione identificata dal relativo ID.

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

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).
id	path	True	string uuid	Identificatore della trascrizione.

Corpo della richiesta

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

Nome	Tipo	Descrizione
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
description	string	Descrizione dell'oggetto .
displayName	string	Nome dell'oggetto.
project	EntityReference	EntityReference

Risposte

Nome	Tipo	Descrizione
200 OK	Transcription	OK Intestazioni Retry-After: integer
Other Status Codes	Error	Si è verificato un errore.

Nome

Tipo

Descrizione

200 OK

Transcription

Intestazioni

Retry-After: integer

Other Status Codes

Error

Si è verificato un errore.

Sicurezza

Ocp-Apim-Subscription-Key

Specificare qui la chiave dell'account dei servizi cognitivi.

Tipo: apiKey
In: header

Authorization

Fornire un token di accesso dal JWT restituito dal servizio 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

Update a transcription

Esempio di richiesta

HTTP

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

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

Risposta di esempio

Codice di stato:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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"
  }
}

Definizioni

Nome	Descrizione
DetailedErrorCode	DettagliErrorCode
DiarizationProperties	Proprietà diarizzazione
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Errore
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PunteggiaturaMode
Status	Stato
Transcription	Trascrizione
TranscriptionLinks	TrascrizioniLinks
TranscriptionProperties	Proprietà di trascrizione
TranscriptionUpdate	TrascrizioneUpdate

DetailedErrorCode

DettagliErrorCode

Nome	Tipo	Descrizione
DataImportFailed	string	Importazione dei dati non riuscita.
DeleteNotAllowed	string	Eliminazione non consentita.
DeployNotAllowed	string	Distribuire non consentito.
DeployingFailedModel	string	Distribuzione di un modello non riuscito.
EmptyRequest	string	Richiesta vuota.
EndpointCannotBeDefault	string	L'endpoint non può essere predefinito.
EndpointNotUpdatable	string	Endpoint non aggiornabile.
EndpointWithoutLogging	string	Endpoint senza registrazione.
ExceededNumberOfRecordingsUris	string	Superato il numero di uri delle registrazioni.
FailedDataset	string	Set di dati non riuscito.
Forbidden	string	Non consentito.
InUseViolation	string	In violazione dell'uso.
InaccessibleCustomerStorage	string	Archiviazione clienti inaccessibile.
InvalidAdaptationMapping	string	Mapping di adattamento non valido.
InvalidBaseModel	string	Modello di base non valido.
InvalidCallbackUri	string	URI di callback non valido.
InvalidChannels	string	Canali non validi.
InvalidCollection	string	Raccolta non valida.
InvalidDataset	string	Set di dati non valido.
InvalidDocument	string	Documento non valido.
InvalidDocumentBatch	string	Batch di documenti non valido.
InvalidLocale	string	Impostazioni locali non valide.
InvalidLogDate	string	Data di log non valida.
InvalidLogEndTime	string	Ora di fine del log non valida.
InvalidLogId	string	ID log non valido.
InvalidLogStartTime	string	Ora di inizio del log non valida.
InvalidModel	string	Modello non valido.
InvalidModelUri	string	URI modello non valido.
InvalidParameter	string	Parametro non valido.
InvalidParameterValue	string	Valore del parametro non valido.
InvalidPayload	string	Payload non valido.
InvalidPermissions	string	Autorizzazioni non valide.
InvalidPrerequisite	string	Prerequisito non valido.
InvalidProductId	string	ID prodotto non valido.
InvalidProject	string	Progetto non valido.
InvalidProjectKind	string	Tipo di progetto non valido.
InvalidRecordingsUri	string	URI registrazioni non valide.
InvalidRequestBodyFormat	string	Formato del corpo della richiesta non valido.
InvalidSasValidityDuration	string	Durata della validità della firma di accesso condiviso non valida.
InvalidSkipTokenForLogs	string	Token ignora non valido per i log.
InvalidSourceAzureResourceId	string	ID risorsa di Azure di origine non valido.
InvalidSubscription	string	Sottoscrizione non valida.
InvalidTest	string	Test non valido.
InvalidTimeToLive	string	Tempo non valido da vivere.
InvalidTopForLogs	string	Top non valido per i log.
InvalidTranscription	string	Trascrizione non valida.
InvalidWebHookEventKind	string	Tipo di evento web hook non valido.
MissingInputRecords	string	Record di input mancanti.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization scaduto.
ModelDeploymentNotCompleteState	string	Distribuzione del modello non completa stato.
ModelDeprecated	string	Modello deprecato.
ModelExists	string	Il modello esiste.
ModelMismatch	string	Mancata corrispondenza del modello.
ModelNotDeployable	string	Modello non distribuibile.
ModelVersionIncorrect	string	Versione del modello non corretta.
NoUtf8WithBom	string	Nessun utf8 con bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Solo uno degli URL o del contenitore o del set di dati.
ProjectGenderMismatch	string	Mancata corrispondenza di genere del progetto.
QuotaViolation	string	Violazione della quota.
SingleDefaultEndpoint	string	Endpoint predefinito singolo.
SkuLimitsExist	string	Esistono limiti di SKU.
SubscriptionNotFound	string	Sottoscrizione non trovata.
UnexpectedError	string	Errore imprevisto.
UnsupportedClassBasedAdaptation	string	Adattamento basato su classi non supportate.
UnsupportedDelta	string	Delta non supportato.
UnsupportedDynamicConfiguration	string	Configurazione dinamica non supportata.
UnsupportedFilter	string	Filtro non supportato.
UnsupportedLanguageCode	string	Codice del linguaggio non supportato.
UnsupportedOrderBy	string	Ordine non supportato per.
UnsupportedPagination	string	Impaginazione non supportata.
UnsupportedTimeRange	string	Intervallo di tempo non supportato.

DiarizationProperties

Proprietà diarizzazione

Nome	Tipo	Descrizione
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Nome	Tipo	Descrizione
maxCount	integer	Numero massimo di altoparlanti per la diarizzazione. Deve essere minore di 36 e maggiore o uguale alla proprietà minSpeakers.
minCount	integer	Suggerimento per il numero minimo di altoparlanti per la diarizzazione. Deve essere minore o uguale alla proprietà maxSpeakers.

EntityError

Nome	Tipo	Descrizione
code	string	Codice di questo errore.
message	string	Messaggio per questo errore.

EntityReference

Nome	Tipo	Descrizione
self	string	Posizione dell'entità a cui si fa riferimento.

Error

Errore

Nome	Tipo	Descrizione
code	ErrorCode	ErrorCode Codici di errore di alto livello.
details	Error[]	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per le API servizi cognitivi disponibili in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene proprietà necessarie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia di valori chiave), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido.

ErrorCode

Nome	Tipo	Descrizione
Conflict	string	Rappresenta il codice di errore del conflitto.
Forbidden	string	Rappresenta il codice di errore non consentito.
InternalCommunicationFailed	string	Rappresentazione del codice di errore interno della comunicazione non riuscita.
InternalServerError	string	Rappresenta il codice di errore del server interno.
InvalidArgument	string	Rappresenta il codice di errore dell'argomento non valido.
InvalidRequest	string	Rappresenta il codice di errore della richiesta non valido.
NotAllowed	string	Rappresenta il codice di errore non consentito.
NotFound	string	Rappresenta il codice di errore non trovato.
PipelineError	string	Rappresenta il codice di errore della pipeline.
ServiceUnavailable	string	Rappresenta il codice di errore non disponibile del servizio.
TooManyRequests	string	Rappresenta il codice di errore di troppe richieste.
Unauthorized	string	Rappresenta il codice di errore non autorizzato.
UnprocessableEntity	string	Rappresenta il codice di errore dell'entità non elaborabile.
UnsupportedMediaType	string	Rappresenta il codice di errore del tipo di supporto non supportato.

InnerError

Nome	Tipo	Descrizione
code	DetailedErrorCode	DettagliErrorCode Enumerazione dettagliata del codice di errore.
details	object	Dettagli aggiuntivi di supporto relativi all'errore e/o ai criteri previsti.
innerError	InnerError	InnerError Nuovo formato di errore interno conforme alle linee guida per le API servizi cognitivi disponibili in https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene proprietà necessarie ErrorCode, message e proprietà facoltative di destinazione, dettagli(coppia di valori chiave), errore interno(può essere annidato).
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore. Ad esempio, sarebbe "documenti" o "ID documento" nel caso di documento non valido.

LanguageIdentificationMode

Nome	Tipo	Descrizione
Continuous	string	Identificazione continua del linguaggio (impostazione predefinita).
Single	string	Identificazione della lingua singola.

LanguageIdentificationProperties

Nome	Tipo	Valore predefinito	Descrizione
candidateLocales	string[]		Le impostazioni locali candidate per l'identificazione della lingua (ad esempio ["en-US", "de-DE", "es-ES"]). Un minimo di 2 e un massimo di 10 impostazioni locali candidati, incluse le impostazioni locali principali per la trascrizione, è supportato per la modalità continua. Per l'identificazione della lingua singola, il numero massimo di impostazioni locali candidati non è associato.
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.

ProfanityFilterMode

Nome	Tipo	Descrizione
Masked	string	Mascherare la volgarità con * tranne la prima lettera, ad esempio f**
None	string	Disabilitare il filtro volgare.
Removed	string	Rimuovere la volgarità.
Tags	string	Aggiungere tag< XML "volgarity" /Profanity>

PunctuationMode

PunteggiaturaMode

Nome	Tipo	Descrizione
Automatic	string	Punteggiatura automatica.
Dictated	string	La punteggiatura dettata contrassegna solo, ad esempio, la punteggiatura esplicita.
DictatedAndAutomatic	string	Segni di punteggiatura dettati o punteggiatura automatica.
None	string	Nessuna punteggiatura.

Status

Stato

Nome	Tipo	Descrizione
Failed	string	L'operazione a esecuzione prolungata non è riuscita.
NotStarted	string	L'operazione a esecuzione prolungata non è ancora stata avviata.
Running	string	L'operazione a esecuzione prolungata è attualmente in elaborazione.
Succeeded	string	L'operazione a esecuzione prolungata è stata completata correttamente.

Transcription

Trascrizione

Nome	Tipo	Descrizione
contentContainerUrl	string	URL per un contenitore BLOB di Azure contenente 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 è 2,5 GB. La firma di accesso condiviso contenitore deve contenere autorizzazioni 'r' (lettura) e 'l' (elenco). Questa proprietà non verrà restituita in una risposta.
contentUrls	string[]	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	Timestamp al momento della creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh: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 è di 256 caratteri e il numero di voci consentite è 10.
dataset	EntityReference	EntityReference
description	string	Descrizione dell'oggetto .
displayName	string	Nome visualizzato dell'oggetto.
lastActionDateTime	string	Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAAA-MM-DDThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TrascrizioniLinks
locale	string	Impostazioni locali dei dati contenuti. Se viene utilizzata l'identificazione della lingua, queste impostazioni locali vengono usate per trascrivere la voce per cui non è possibile rilevare alcuna lingua.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	Proprietà di trascrizione
self	string	Posizione di questa entità.
status	Status	Stato Descrivere lo stato corrente dell'API.

TranscriptionLinks

TrascrizioniLinks

Nome	Tipo	Descrizione
files	string	Percorso per ottenere tutti i file di questa entità. Per altre informazioni, vedere l'operazione "Transcriptions_ListFiles".

TranscriptionProperties

Proprietà di trascrizione

Nome	Tipo	Descrizione
channels	integer[]	Raccolta dei numeri di canale richiesti. Nel caso predefinito, i canali 0 e 1 vengono considerati.
destinationContainerUrl	string	Contenitore di destinazione richiesto. Commenti Quando un contenitore di destinazione viene usato in combinazione con , `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)" anziché `destinationContainerUrl`, dove i BLOB possono essere puliti.
diarization	DiarizationProperties	Proprietà diarizzazione
diarizationEnabled	boolean	Valore che indica se viene richiesta la diarizzazione (identificazione dell'altoparlante). 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 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 `diarizationEnabled` impostazione 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 per inviare notifiche di posta elettronica a nel caso in cui l'operazione venga completata. Il valore verrà rimosso dopo aver inviato correttamente il messaggio di posta elettronica.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modalità di filtro volgare.
punctuationMode	PunctuationMode	PunteggiaturaMode Modalità utilizzata per la punteggiatura.
timeToLive	string	Per quanto tempo la trascrizione verrà mantenuta nel sistema dopo il completamento. Dopo aver raggiunto il tempo di esecuzione della trascrizione dopo il completamento (riuscito o non riuscito), la trascrizione verrà eliminata automaticamente. Non impostando questo valore o impostandolo su 0 verrà disabilitata l'eliminazione automatica. 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`.

TranscriptionUpdate

TrascrizioneUpdate

Nome	Tipo	Descrizione
customProperties	object	Proprietà personalizzate di questa entità. La lunghezza massima consentita della chiave è di 64 caratteri, la lunghezza massima consentita è di 256 caratteri e il numero di voci consentite è 10.
description	string	Descrizione dell'oggetto .
displayName	string	Nome dell'oggetto.
project	EntityReference	EntityReference

Condividi tramite

Transcriptions - Update

Parametri dell'URI

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Authorization

Esempio

Update a transcription

Esempio di richiesta

Risposta di esempio

Definizioni

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Commenti

TranscriptionUpdate

Risorse aggiuntive