你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Batch Syntheses - Create

创建批处理合成作业,允许的最大有效负载内容长度为 2 MB。

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

URI 参数

名称 必需 类型 说明
endpoint
path True

string

支持的认知服务终结点 (协议和主机名,例如: https://eastus.api.cognitive.microsoft.com) 。

id
path True

string

资源的 ID。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
Ocp-Apim-Subscription-Key True

string

在此处提供认知服务订阅密钥。

Operation-Id

string

操作的状态监视器的 ID。 如果 Operation-Id 标头与现有操作匹配,并且请求与以前的请求不同,则失败并显示 400 错误请求。

正则表达式模式: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

请求正文

名称 必需 类型 说明
inputKind True

InputKind

输入文本类型。

customVoices

object

语音名称和部署 ID 的自定义语音映射。

description

string

批处理合成任务的说明。

id

string

资源 ID

inputs

BatchSynthesisInput[]

文本或 SSML 输入,最多允许 10000 个项目。

properties

BatchSynthesisProperties

批处理合成任务的详细属性。

synthesisConfig

BatchSynthesisConfig

纯文本输入的文本转语音配置。

响应

名称 类型 说明
201 Created

BatchSynthesis

创建

标头

  • operation-id: string
  • operation-location: string
Other Status Codes

ErrorResponse

出现了错误。

标头

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

在此处提供认知服务订阅密钥。

类型: apiKey
在: header

示例

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.

示例请求

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

示例响应

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.

示例请求

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."
    }
  ]
}

示例响应

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

定义

名称 说明
BatchSynthesis

浴合成任务。

BatchSynthesisBackgroundAudioDefinition

后台音频设置。

BatchSynthesisBillingDetails

Bath 合成计费详细信息。

BatchSynthesisConfig

纯文本输入的文本转语音配置。

BatchSynthesisError

批处理合成错误。

BatchSynthesisInput

批量合成输入。

BatchSynthesisOutputs

批量合成输出。

BatchSynthesisProperties

批处理合成任务的详细属性。

Error

错误对象。

ErrorCode

顶级错误代码

ErrorResponse

错误响应。

InnerError

包含有关错误的更具体信息的对象。

InputKind

输入文本类型。

Status

资源的状态。

BatchSynthesis

浴合成任务。

名称 类型 说明
createdDateTime

string

创建对象时的时间戳。

customVoices

object

语音名称和部署 ID 的自定义语音映射。

description

string

批处理合成任务的说明。

id

string

资源 ID

inputKind

InputKind

输入文本类型。

inputs

BatchSynthesisInput[]

文本或 SSML 输入,最多允许 10000 个项目。

lastActionDateTime

string

输入当前状态时的时间戳。

outputs

BatchSynthesisOutputs

批量合成输出。

properties

BatchSynthesisProperties

批处理合成任务的详细属性。

status

Status

资源的状态。

synthesisConfig

BatchSynthesisConfig

纯文本输入的文本转语音配置。

BatchSynthesisBackgroundAudioDefinition

后台音频设置。

名称 类型 说明
fadein

integer

背景音频的淡出值。 引用 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio

fadeout

integer

背景音频的淡出值。 引用 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio

src

string

音频文件的源。 引用 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio

volume

number

后台音频的音量值。 引用 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#add-background-audio

BatchSynthesisBillingDetails

Bath 合成计费详细信息。

名称 类型 说明
aoaiCharacters

integer

输入文件中 AOAI 语音的计费字符数。

aoaiHDCharacters

integer

输入文件中 AOAI HD 语音的计费字符数。

customNeuralCharacters

integer

输入文件中自定义神经语音的可计费字符数。

neuralCharacters

integer

输入文件中预生成神经语音的可计费字符数。

personalVoiceCharacters

integer

输入文件中个人语音的计费字符数。

BatchSynthesisConfig

纯文本输入的文本转语音配置。

名称 类型 说明
backgroundAudio

BatchSynthesisBackgroundAudioDefinition

后台音频设置。

pitch

string

纯文本输入的音调。 有关支持的值,请参阅 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody

rate

string

PlainText 输入的朗读率。 有关支持的值,请参阅 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody

style

string

纯文本输入的样式名称。

voice

string

纯文本输入的语音名称。 可在此处 https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts找到平台语音列表。

volume

string

纯文本输入的卷。 有关支持的值,请参阅 https://learn.microsoft.com/azure/ai-services/speech-service/speech-synthesis-markup-voice#adjust-prosody

BatchSynthesisError

批处理合成错误。

名称 类型 说明
code

string

顶级错误代码

message

string

错误消息

BatchSynthesisInput

批量合成输入。

名称 类型 说明
content

string

可以是 SSML 或纯文本。

BatchSynthesisOutputs

批量合成输出。

名称 类型 说明
result

string

结果文件的 sas URL。 指定“destinationContainerUrl”时,它将是相对路径。

summary

string

当 BatchSynthesisProperties.decompressOutputFiles 为 true 时,将在此处提供作业摘要文件路径。

BatchSynthesisProperties

批处理合成任务的详细属性。

名称 类型 说明
billingDetails

BatchSynthesisBillingDetails

Bath 合成计费详细信息。

concatenateResult

boolean

合成结果是否串联。

decompressOutputFiles

boolean

合成结果是否在目标容器中解压缩。 仅当指定了“destinationContainerUrl”或配置了“BYOS”时,它才会生效。

destinationContainerUrl

string

请求的目标容器。 它是 Azure Blob 存储中可写容器的具有服务临时 SAS 的 URL。

destinationPath

string

目标容器中的目标路径默认为 null,它仅在指定“DestinationContainerUrl”时有效,输出的最终路径前缀应为 {DestinationPath}/{TaskId}/或 {TaskId}(如果未指定)。

durationInMilliseconds

integer

生成的音频持续时间(以毫秒为单位)。

error

BatchSynthesisError

批处理合成错误。

failedAudioCount

integer

失败的音频数。

outputFormat

string

请求的音频输出格式。 引用 https://learn.microsoft.com/azure/ai-services/speech-service/batch-synthesis-properties#batch-synthesis-properties

sentenceBoundaryEnabled

boolean

是否将生成句子边界输出。

sizeInBytes

integer

生成的音频大小(以字节为单位)。

succeededAudioCount

integer

成功的音频数。

timeToLiveInHours

integer

批处理任务在完成后将在系统中保留多长时间。 批处理任务在完成后到达生存时间后 (成功或失败) 将自动删除。 最长支持持续时间为 744 小时 (31 天) 。 默认值为 744 小时。

wordBoundaryEnabled

boolean

是否将生成单词边界输出。

Error

错误对象。

名称 类型 说明
code

ErrorCode

顶级错误代码

details

Error[]

有关错误和/或预期策略的其他支持详细信息。

innererror

InnerError

包含有关错误的更具体信息的对象。

message

string

高级错误消息。

target

string

错误的源。

ErrorCode

顶级错误代码

名称 类型 说明
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

错误响应。

名称 类型 说明
error

Error

错误对象。

InnerError

包含有关错误的更具体信息的对象。

名称 类型 说明
code

string

帮助诊断的详细错误代码。

innererror

InnerError

包含有关错误的更具体信息的对象。

message

string

详细的错误消息。

target

string

错误的源。

InputKind

输入文本类型。

名称 类型 说明
PlainText

string

SSML

string

Status

资源的状态。

名称 类型 说明
Failed

string

NotStarted

string

Running

string

Succeeded

string