Batch Syntheses - Create

Riferimento

Servizio:: Azure AI Services

Versione API:: 2024-04-01

Crea un processo di sintesi batch, la lunghezza massima consentita del contenuto del payload è di 2 megabyte.

PUT {endpoint}/texttospeech/batchsyntheses/{id}?api-version=2024-04-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
endpoint	path	True	string	Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID della risorsa.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string	Specificare la chiave di sottoscrizione di Servizi cognitivi qui.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID del monitoraggio dello stato per l'operazione. Se l'intestazione Operation-Id corrisponde a un'operazione esistente e la richiesta non è identica alla richiesta precedente, avrà esito negativo con una richiesta 400 non valida.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
inputKind	True	InputKind	Tipo di testo di input.
customVoices		object	Mappa vocale personalizzata del nome vocale e dell'ID distribuzione.
description		string	Descrizione dell'attività di sintesi batch.
id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID risorsa
inputs		BatchSynthesisInput[]	Input di testo o SSML, sono consentiti fino a 10000 elementi.
properties		BatchSynthesisProperties	Proprietà dettagliate dell'attività di sintesi batch.
synthesisConfig		BatchSynthesisConfig	Configurazione della sintesi vocale per l'input di testo normale.

Risposte

Nome	Tipo	Descrizione
201 Created	BatchSynthesis	Creato Intestazioni operation-id: string operation-location: string
Other Status Codes	ErrorResponse	Si è verificato un errore. Intestazioni x-ms-error-code: string

Nome

Tipo

Descrizione

201 Created

BatchSynthesis

Creato

Intestazioni

operation-id: string
operation-location: string

Other Status Codes

ErrorResponse

Si è verificato un errore.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave di sottoscrizione di Servizi cognitivi qui.

Tipo: apiKey
In: header

Esempio

Create a batch synthesis job with ssml input and user provided container output.

Create a batch synthesis job with text input.

Create a batch synthesis job with ssml input and user provided container output.

Esempio di richiesta

HTTP

PUT {endpoint}/texttospeech/batchsyntheses/my-batch-synthesis-job-ssml-input-1?api-version=2024-04-01



{
  "inputKind": "SSML",
  "inputs": [
    {
      "content": "<speak version=\"1.0\" xml:lang=\"en-US\"><voice name=\"en-US-JennyNeural\">The rainbow has seven colors.</voice></speak>"
    }
  ],
  "properties": {
    "destinationContainerUrl": "https://contoso.blob.core.windows.net/default?sv=2021-04-10&st=2024-03-15T04%3A47%3A54Z&se=2025-03-16T04%3A47%3A00Z&sr=c&sp=racwdl&sig=Masked",
    "decompressOutputFiles": true
  }
}

Risposta di esempio

Codice di stato:: 201

operation-location: https://eastus.api.cognitive.microsoft.com/texttospeech/operations/f43cb3f3-e35d-4df7-9b0f-9f2a49693d1af?api-version=2024-04-01
operation-id: f43cb3f3-e35d-4df7-9b0f-9f2a49693d1a

{
  "id": "my-batch-synthesis-job-ssml-input-1",
  "status": "NotStarted",
  "createdDateTime": "2024-03-15T06:03:33.808822Z",
  "lastActionDateTime": "2024-03-15T06:03:33.8088223Z",
  "inputKind": "SSML",
  "customVoices": {},
  "properties": {
    "timeToLiveInHours": 744,
    "outputFormat": "riff-24khz-16bit-mono-pcm",
    "concatenateResult": false,
    "decompressOutputFiles": true,
    "wordBoundaryEnabled": false,
    "sentenceBoundaryEnabled": false,
    "destinationContainerUrl": "https://contoso.blob.core.windows.net/default?sv=2021-04-10&st=2024-03-15T04%3A47%3A54Z&se=2025-03-16T04%3A47%3A00Z&sr=c&sp=racwdl&sig=Masked"
  }
}

Create a batch synthesis job with text input.

Esempio di richiesta

HTTP

PUT {endpoint}/texttospeech/batchsyntheses/my-batch-synthesis-job-text-input-1?api-version=2024-04-01



{
  "inputKind": "PlainText",
  "synthesisConfig": {
    "voice": "en-US-JennyNeural"
  },
  "inputs": [
    {
      "content": "The rainbow has seven colors."
    }
  ]
}

Risposta di esempio

Codice di stato:: 201

operation-location: https://eastus.api.cognitive.microsoft.com/texttospeech/operations/06c7f835-e07b-4ac8-b33c-5b6df4a4eeef?api-version=2024-04-01
operation-id: 06c7f835-e07b-4ac8-b33c-5b6df4a4eeef

{
  "id": "my-batch-synthesis-job-text-input-1",
  "status": "NotStarted",
  "createdDateTime": "2024-03-15T06:19:18.0059236Z",
  "lastActionDateTime": "2024-03-15T06:19:18.0059238Z",
  "inputKind": "PlainText",
  "customVoices": {},
  "properties": {
    "timeToLiveInHours": 744,
    "outputFormat": "riff-24khz-16bit-mono-pcm",
    "concatenateResult": false,
    "decompressOutputFiles": false,
    "wordBoundaryEnabled": false,
    "sentenceBoundaryEnabled": false
  },
  "synthesisConfig": {
    "voice": "en-US-JennyNeural"
  }
}

Definizioni

Nome	Descrizione
BatchSynthesis	Attività di sintesi bagno.
BatchSynthesisBackgroundAudioDefinition	Impostazione audio in background.
BatchSynthesisBillingDetails	Dettagli di fatturazione per la sintesi del bagno.
BatchSynthesisConfig	Configurazione della sintesi vocale per l'input di testo normale.
BatchSynthesisError	Errore di sintesi batch.
BatchSynthesisInput	Input di sintesi batch.
BatchSynthesisOutputs	Output di Sintesi batch.
BatchSynthesisProperties	Proprietà dettagliate dell'attività di sintesi batch.
Error	Oggetto error.
ErrorCode	Codice di errore di primo livello
ErrorResponse	Risposta di errore.
InnerError	Oggetto contenente informazioni più specifiche sull'errore.
InputKind	Tipo di testo di input.
Status	Stato di una risorsa.

BatchSynthesis

Object

Attività di sintesi bagno.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Timestamp al momento della creazione dell'oggetto.
customVoices	object	Mappa vocale personalizzata del nome vocale e dell'ID distribuzione.
description	string	Descrizione dell'attività di sintesi batch.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID risorsa
inputKind	InputKind	Tipo di testo di input.
inputs	BatchSynthesisInput[]	Input di testo o SSML, sono consentiti fino a 10000 elementi.
lastActionDateTime	string (date-time)	Timestamp quando è stato immesso lo stato corrente.
outputs	BatchSynthesisOutputs	Output di Sintesi batch.
properties	BatchSynthesisProperties	Proprietà dettagliate dell'attività di sintesi batch.
status	Status	Stato di una risorsa.
synthesisConfig	BatchSynthesisConfig	Configurazione della sintesi vocale per l'input di testo normale.

BatchSynthesisBackgroundAudioDefinition

Object

Impostazione audio in background.

Nome	Tipo	Descrizione
fadein	integer (int64)	Valore dissolvenza dell'audio in background. Riferimento https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
fadeout	integer (int64)	Valore di dissolvenza dell'audio in background. Riferimento https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
src	string (uri)	Origine del file audio. Riferimento https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
volume	number (double)	Valore del volume dell'audio in background. Riferimento https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.

BatchSynthesisBillingDetails

Object

Dettagli di fatturazione per la sintesi del bagno.

Nome	Tipo	Descrizione
aoaiCharacters	integer (int64)	Numero di caratteri fatturabili per le voci AOAI nel file di input.
aoaiHDCharacters	integer (int64)	Numero di caratteri fatturabili per le voci HD AOAI nel file di input.
customNeuralCharacters	integer (int64)	Numero di caratteri fatturabili per voci neurali personalizzate nel file di input.
neuralCharacters	integer (int64)	Numero di caratteri fatturabili per le voci neurali predefinite nel file di input.
personalVoiceCharacters	integer (int64)	Numero di caratteri fatturabili per le voci personali nel file di input.

BatchSynthesisConfig

Object

Configurazione della sintesi vocale per l'input di testo normale.

Nome	Tipo	Descrizione
backgroundAudio	BatchSynthesisBackgroundAudioDefinition	Impostazione audio in background.
pitch	string	Pitch per l'input PlainText. Per i valori supportati, vedere https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
rate	string	Velocità di pronuncia per l'input PlainText. Per i valori supportati, vedere https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
style	string	Nome dello stile per l'input PlainText.
voice	string minLength: 1	Nome vocale per l'input PlainText. È possibile trovare l'elenco voci della piattaforma qui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
volume	string	Volume per l'input PlainText. Per i valori supportati, vedere https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.

BatchSynthesisError

Object

Errore di sintesi batch.

Nome	Tipo	Descrizione
code	string	Codice di errore di primo livello
message	string	Messaggio di errore

BatchSynthesisInput

Object

Input di sintesi batch.

Nome	Tipo	Descrizione
content	string minLength: 1	Potrebbe trattarsi di SSML o testo normale.

BatchSynthesisOutputs

Object

Output di Sintesi batch.

Nome	Tipo	Descrizione
result	string	SAS URL del file di risultati. Sarebbe un percorso relativo quando viene specificato "destinationContainerUrl".
summary	string	Quando BatchSynthesisProperties.decompressOutputFiles è true, qui verrà fornito il percorso del file di riepilogo del processo.

BatchSynthesisProperties

Object

Proprietà dettagliate dell'attività di sintesi batch.

Nome	Tipo	Descrizione
billingDetails	BatchSynthesisBillingDetails	Dettagli di fatturazione per la sintesi del bagno.
concatenateResult	boolean	Indica se il risultato della sintesi è concatenato.
decompressOutputFiles	boolean	Indica se il risultato della sintesi è decompresso nel contenitore di destinazione. Ha effetto solo quando viene specificato "destinationContainerUrl" o "BYOS".
destinationContainerUrl	string (uri)	Contenitore di destinazione richiesto. Si tratta di un URL con firma di accesso condiviso ad hoc del servizio in un contenitore scrivibile nell'archiviazione BLOB di Azure.
destinationPath	string	Il percorso di destinazione nel contenitore di destinazione, per impostazione predefinita null, funziona solo quando viene specificato "DestinationContainerUrl", il prefisso del percorso finale degli output deve essere {DestinationPath}/{TaskId}/, o {TaskId} se non specificato.
durationInMilliseconds	integer (int32)	Durata audio generata in millisecondi.
error	BatchSynthesisError	Errore di sintesi batch.
failedAudioCount	integer (int32)	Numero di audio non riusciti.
outputFormat	string	Formato di output audio richiesto. Riferimento https://learn.microsoft.com/azure/ai-services/speech-service/batch-synthesis-properties#batch-synthesis-properties.
sentenceBoundaryEnabled	boolean	Indica se verrà generato l'output del limite della frase.
sizeInBytes	integer (int64)	Dimensioni audio generate in byte.
succeededAudioCount	integer (int32)	Numero di audio riusciti.
timeToLiveInHours	integer (int32)	Per quanto tempo l'attività batch verrà mantenuta nel sistema dopo il completamento. Quando l'attività batch raggiunge il tempo di esecuzione dopo il completamento (riuscito o non riuscito), l'attività batch verrà eliminata automaticamente. La durata supportata più lunga è di 744 ore (31 giorni). Il valore predefinito è 744 ore.
wordBoundaryEnabled	boolean	Indica se verrà generato l'output del limite di parola.

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Codice di errore di primo livello
details	Error[]	Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.
innererror	InnerError	Oggetto contenente informazioni più specifiche sull'errore.
message	string	Messaggio di errore di alto livello.
target	string	Indica l'origine dell'errore.

ErrorCode

Enumerazione

Codice di errore di primo livello

Valore	Descrizione
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerError

Object

Oggetto contenente informazioni più specifiche sull'errore.

Nome	Tipo	Descrizione
code	string	Codice di errore dettagliato per facilitare la diagnostica.
innererror	InnerError	Oggetto contenente informazioni più specifiche sull'errore.
message	string	Messaggio di errore dettagliato.
target	string	Indica l'origine dell'errore.

InputKind

Enumerazione

Tipo di testo di input.

Valore	Descrizione
PlainText
SSML

Status

Enumerazione

Stato di una risorsa.

Valore	Descrizione
Failed
NotStarted
Running
Succeeded

Condividi tramite

Batch Syntheses - Create

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

Ocp-Apim-Subscription-Key

Esempio

Create a batch synthesis job with ssml input and user provided container output.

Esempio di richiesta

Risposta di esempio

Create a batch synthesis job with text input.

Esempio di richiesta

Risposta di esempio

Definizioni

BatchSynthesis

BatchSynthesisBackgroundAudioDefinition

BatchSynthesisBillingDetails

BatchSynthesisConfig

BatchSynthesisError

BatchSynthesisInput

BatchSynthesisOutputs

BatchSynthesisProperties

Error

ErrorCode

ErrorResponse

InnerError

InputKind

Status