Batch Syntheses - Get

Referensi

Layanan:: Azure AI Services

Versi API:: 2024-04-01

Mendapatkan sintesis batch yang diidentifikasi oleh ID yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: 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 sumber daya.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string	Berikan kunci langganan layanan kognitif Anda di sini.

Respons

Nama	Jenis	Deskripsi
200 OK	BatchSynthesis	Keberhasilan
Other Status Codes	ErrorResponse	Terjadi kesalahan. Header x-ms-error-code: string

Nama

Jenis

Deskripsi

200 OK

BatchSynthesis

Keberhasilan

Other Status Codes

ErrorResponse

Terjadi kesalahan.

Header

x-ms-error-code: string

Keamanan

Ocp-Apim-Subscription-Key

Berikan kunci langganan layanan kognitif Anda di sini.

Jenis: apiKey
Dalam: header

Contoh

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

get a batch synthesis job.

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

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "id": "my-batch-synthesis-job-ssml-input-1",
  "status": "Succeeded",
  "createdDateTime": "2024-03-15T06:03:33.808822Z",
  "lastActionDateTime": "2024-03-15T06:03:34.9367114",
  "inputKind": "SSML",
  "customVoices": {},
  "properties": {
    "timeToLiveInHours": 744,
    "outputFormat": "riff-24khz-16bit-mono-pcm",
    "concatenateResult": false,
    "decompressOutputFiles": true,
    "wordBoundaryEnabled": true,
    "sentenceBoundaryEnabled": true,
    "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",
    "sizeInBytes": 120000,
    "succeededAudioCount": 1,
    "failedAudioCount": 0,
    "durationInMilliseconds": 2500,
    "billingDetails": {
      "neuralCharacters": 29
    }
  },
  "outputs": {
    "result": "29f2105f997c4bfea176d39d05ff201e/my-batch-synthesis-job-ssml-input-1",
    "summary": "29f2105f997c4bfea176d39d05ff201e/my-batch-synthesis-job-ssml-input-1/summary.json"
  }
}

get a batch synthesis job.

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

{
  "id": "my-batch-synthesis-job-text-input-1",
  "status": "Succeeded",
  "createdDateTime": "2024-03-15T06:19:18.0059236Z",
  "lastActionDateTime": "2024-03-15T06:19:19.0306365",
  "inputKind": "PlainText",
  "customVoices": {},
  "properties": {
    "timeToLiveInHours": 744,
    "outputFormat": "riff-24khz-16bit-mono-pcm",
    "concatenateResult": false,
    "decompressOutputFiles": false,
    "wordBoundaryEnabled": false,
    "sentenceBoundaryEnabled": false,
    "sizeInBytes": 120000,
    "succeededAudioCount": 1,
    "failedAudioCount": 0,
    "durationInMilliseconds": 2500,
    "billingDetails": {
      "neuralCharacters": 29
    }
  },
  "synthesisConfig": {
    "voice": "en-US-JennyNeural"
  },
  "outputs": {
    "result": "https://stttssvcuse.blob.core.windows.net/batchsynthesis-output/29f2105f997c4bfea176d39d05ff201e/my-batch-synthesis-job-text-input-1/results.zip?SAS_Token"
  }
}

Definisi

Nama	Deskripsi
BatchSynthesis	Tugas sintesis mandi.
BatchSynthesisBackgroundAudioDefinition	Pengaturan audio latar belakang.
BatchSynthesisBillingDetails	Detail penagihan sintesis mandi.
BatchSynthesisConfig	Konfigurasi teks ke ucapan untuk input teks biasa.
BatchSynthesisError	Kesalahan Sintesis Batch.
BatchSynthesisInput	Input Sintesis Batch.
BatchSynthesisOutputs	Output Sintesis Batch.
BatchSynthesisProperties	Properti terperinci dari tugas sintesis batch.
Error	Objek kesalahan.
ErrorCode	Kode kesalahan tingkat atas
ErrorResponse	Respons kesalahan.
InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
InputKind	Jenis teks input.
Status	Status sumber daya.

BatchSynthesis

Objek

Tugas sintesis mandi.

Nama	Jenis	Deskripsi
createdDateTime	string (date-time)	Stempel waktu saat objek dibuat.
customVoices	object	Peta suara kustom nama suara dan ID penyebaran.
description	string	Deskripsi tugas sintesis batch.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Id sumber daya
inputKind	InputKind	Jenis teks input.
inputs	BatchSynthesisInput[]	Input teks atau SSML, diperbolehkan hingga 10000 item.
lastActionDateTime	string (date-time)	Stempel waktu ketika status saat ini dimasukkan.
outputs	BatchSynthesisOutputs	Output Sintesis Batch.
properties	BatchSynthesisProperties	Properti terperinci dari tugas sintesis batch.
status	Status	Status sumber daya.
synthesisConfig	BatchSynthesisConfig	Konfigurasi teks ke ucapan untuk input teks biasa.

BatchSynthesisBackgroundAudioDefinition

Objek

Pengaturan audio latar belakang.

Nama	Jenis	Deskripsi
fadein	integer (int64)	Nilai memudar dari audio latar belakang. Referensi https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
fadeout	integer (int64)	Nilai memudar dari audio latar belakang. Referensi https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
src	string (uri)	Sumber file audio. Referensi https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.
volume	number (double)	Nilai volume audio latar belakang. Referensi https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio.

BatchSynthesisBillingDetails

Objek

Detail penagihan sintesis mandi.

Nama	Jenis	Deskripsi
aoaiCharacters	integer (int64)	Jumlah karakter yang dapat ditagih untuk suara AOAI dalam file input.
aoaiHDCharacters	integer (int64)	Jumlah karakter yang dapat ditagih untuk suara AOAI HD dalam file input.
customNeuralCharacters	integer (int64)	Jumlah karakter yang dapat ditagih untuk suara neural kustom dalam file input.
neuralCharacters	integer (int64)	Jumlah karakter yang dapat ditagih untuk suara neural bawaan dalam file input.
personalVoiceCharacters	integer (int64)	Jumlah karakter yang dapat ditagih untuk suara pribadi dalam file input.

BatchSynthesisConfig

Objek

Konfigurasi teks ke ucapan untuk input teks biasa.

Nama	Jenis	Deskripsi
backgroundAudio	BatchSynthesisBackgroundAudioDefinition	Pengaturan audio latar belakang.
pitch	string	Pitch untuk input PlainText. Untuk nilai yang didukung, lihat https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
rate	string	Tingkat bicara untuk input PlainText. Untuk nilai yang didukung, lihat https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.
style	string	Nama gaya untuk input PlainText.
voice	string minLength: 1	Nama suara untuk input PlainText. Anda dapat menemukan daftar suara platform di sini https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
volume	string	Volume untuk input PlainText. Untuk nilai yang didukung, lihat https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody.

BatchSynthesisError

Objek

Kesalahan Sintesis Batch.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan tingkat atas
message	string	Pesan kesalahan

BatchSynthesisInput

Objek

Input Sintesis Batch.

Nama	Jenis	Deskripsi
content	string minLength: 1	Bisa jadi SSML atau teks biasa.

BatchSynthesisOutputs

Objek

Output Sintesis Batch.

Nama	Jenis	Deskripsi
result	string	url sas dari file hasil. Ini akan menjadi jalur relatif ketika "destinationContainerUrl" ditentukan.
summary	string	Ketika BatchSynthesisProperties.decompressOutputFiles benar, jalur file ringkasan pekerjaan akan disediakan di sini.

BatchSynthesisProperties

Objek

Properti terperinci dari tugas sintesis batch.

Nama	Jenis	Deskripsi
billingDetails	BatchSynthesisBillingDetails	Detail penagihan sintesis mandi.
concatenateResult	boolean	Apakah hasil sintesis digabungkan.
decompressOutputFiles	boolean	Apakah hasil sintesis didekompresi dalam kontainer target. Ini hanya berlaku ketika "destinationContainerUrl" ditentukan atau "BYOS" dikonfigurasi.
destinationContainerUrl	string (uri)	Kontainer tujuan yang diminta. Ini adalah URL dengan SaS adhoc Layanan ke kontainer yang dapat ditulis di penyimpanan Azure Blob.
destinationPath	string	Jalur tujuan dalam kontainer tujuan, default ke null, hanya berfungsi ketika "DestinationContainerUrl" ditentukan, awalan jalur akhir output harus {DestinationPath}/{TaskId}/, atau {TaskId} jika tidak ditentukan.
durationInMilliseconds	integer (int32)	Durasi audio yang dihasilkan dalam milidetik.
error	BatchSynthesisError	Kesalahan Sintesis Batch.
failedAudioCount	integer (int32)	Jumlah audio yang gagal.
outputFormat	string	Format output audio yang diminta. Referensi https://learn.microsoft.com/azure/ai-services/speech-service/batch-synthesis-properties#batch-synthesis-properties.
sentenceBoundaryEnabled	boolean	Apakah output batas kalimat akan dihasilkan.
sizeInBytes	integer (int64)	Ukuran audio yang dihasilkan dalam byte.
succeededAudioCount	integer (int32)	Jumlah audio yang berhasil.
timeToLiveInHours	integer (int32)	Berapa lama tugas batch akan disimpan dalam sistem setelah selesai. Setelah tugas batch mencapai waktu hidup setelah selesai (berhasil atau gagal) tugas tersebut akan dihapus secara otomatis. Durasi terlama yang didukung adalah 744 jam (31 hari). Nilai defaultnya adalah 744 jam.
wordBoundaryEnabled	boolean	Apakah output batas kata akan dihasilkan.

Error

Objek

Objek kesalahan.

Nama	Jenis	Deskripsi
code	ErrorCode	Kode kesalahan tingkat atas
details	Error[]	Detail dukungan tambahan mengenai kesalahan dan/atau kebijakan yang diharapkan.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
message	string	Pesan kesalahan tingkat tinggi.
target	string	Sumber kesalahan.

ErrorCode

Enumeration

Kode kesalahan tingkat atas

Nilai	Deskripsi
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objek

Respons kesalahan.

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerError

Objek

Objek yang berisi informasi yang lebih spesifik tentang kesalahan.

Nama	Jenis	Deskripsi
code	string	Kode kesalahan terperinci untuk membantu diagnostik.
innererror	InnerError	Objek yang berisi informasi yang lebih spesifik tentang kesalahan.
message	string	Pesan kesalahan terperinci.
target	string	Sumber kesalahan.

InputKind

Enumeration

Jenis teks input.

Nilai	Deskripsi
PlainText
SSML

Status

Enumeration

Status sumber daya.

Nilai	Deskripsi
Failed
NotStarted
Running
Succeeded

Bagikan melalui

Batch Syntheses - Get

Parameter URI

Header Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

Contoh

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

Permintaan sampel

Respon sampel

get a batch synthesis job.

Permintaan sampel

Respon sampel

Definisi

BatchSynthesis

BatchSynthesisBackgroundAudioDefinition

BatchSynthesisBillingDetails

BatchSynthesisConfig

BatchSynthesisError

BatchSynthesisInput

BatchSynthesisOutputs

BatchSynthesisProperties

Error

ErrorCode

ErrorResponse

InnerError

InputKind

Status