Skip to content

Commit 39e41d3

Browse files
authored
Merge pull request #278101 from ForrestGumb/patch-15
Update Custom Voice API version in rest.md
2 parents 03dc262 + e2a3679 commit 39e41d3

File tree

10 files changed

+68
-68
lines changed

10 files changed

+68
-68
lines changed

articles/ai-services/speech-service/includes/how-to/professional-voice/create-consent/rest.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ ms.custom: include
1111

1212
With the professional voice feature, it's required that every voice be created with explicit consent from the user. A recorded statement from the user is required acknowledging that the customer (Azure AI Speech resource owner) will create and use their voice.
1313

14-
To add voice talent consent to the professional voice project, you get the prerecorded consent audio file from a publicly accessible URL ([Consents_Create](/rest/api/speechapi/consents/create)) or upload the audio file ([Consents_Post](/rest/api/speechapi/consents/post)). In this article, you add consent from a URL.
14+
To add voice talent consent to the professional voice project, you get the prerecorded consent audio file from a publicly accessible URL ([Consents_Create](/rest/api/aiservices/speechapi/consents/create)) or upload the audio file ([Consents_Post](/rest/api/aiservices/speechapi/consents/post)). In this article, you add consent from a URL.
1515

1616
## Consent statement
1717

@@ -25,15 +25,15 @@ You can get the consent statement text for each locale from the text to speech G
2525

2626
## Add consent from a URL
2727

28-
To add consent to a professional voice project from the URL of an audio file, use the [Consents_Create](/rest/api/speechapi/consents/create) operation of the custom voice API. Construct the request body according to the following instructions:
28+
To add consent to a professional voice project from the URL of an audio file, use the [Consents_Create](/rest/api/aiservices/speechapi/consents/create) operation of the custom voice API. Construct the request body according to the following instructions:
2929

3030
- Set the required `projectId` property. See [create a project](../../../../professional-voice-create-project.md).
3131
- Set the required `voiceTalentName` property. The voice talent name can't be changed later.
3232
- Set the required `companyName` property. The company name can't be changed later.
3333
- Set the required `audioUrl` property. The URL of the voice talent consent audio file. Use a URI with the [shared access signatures (SAS)](/azure/storage/common/storage-sas-overview) token.
3434
- Set the required `locale` property. This should be the locale of the consent. The locale can't be changed later. You can find the text to speech locale list [here](/azure/ai-services/speech-service/language-support?tabs=tts).
3535

36-
Make an HTTP PUT request using the URI as shown in the following [Consents_Create](/rest/api/speechapi/consents/create) example.
36+
Make an HTTP PUT request using the URI as shown in the following [Consents_Create](/rest/api/aiservices/speechapi/consents/create) example.
3737
- Replace `YourResourceKey` with your Speech resource key.
3838
- Replace `YourResourceRegion` with your Speech resource region.
3939
- Replace `JessicaConsentId` with a consent ID of your choice. The case sensitive ID will be used in the consent's URI and can't be changed later.
@@ -46,7 +46,7 @@ curl -v -X PUT -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type:
4646
"companyName": "Contoso",
4747
"audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
4848
"locale": "en-US"
49-
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/consents/JessicaConsentId?api-version=2023-12-01-preview"
49+
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/consents/JessicaConsentId?api-version=2024-02-01-preview"
5050
```
5151

5252
You should receive a response body in the following format:
@@ -65,10 +65,10 @@ You should receive a response body in the following format:
6565
}
6666
```
6767

68-
The response header contains the `Operation-Location` property. Use this URI to get details about the [Consents_Create](/rest/api/speechapi/consents/create) operation. Here's an example of the response header:
68+
The response header contains the `Operation-Location` property. Use this URI to get details about the [Consents_Create](/rest/api/aiservices/speechapi/consents/create) operation. Here's an example of the response header:
6969

7070
```HTTP 201
71-
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2023-12-01-preview
71+
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2024-02-01-preview
7272
Operation-Id: 070f7986-ef17-41d0-ba2b-907f0f28e314
7373
```
7474

articles/ai-services/speech-service/includes/how-to/professional-voice/create-project/rest.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Each project is specific to a country/region and language, and the gender of the
1515

1616
## Create a project
1717

18-
To create a professional voice project, use the [Projects_Create](/rest/api/speechapi/projects/create) operation of the custom voice API. Construct the request body according to the following instructions:
18+
To create a professional voice project, use the [Projects_Create](/rest/api/aiservices/speechapi/projects/create) operation of the custom voice API. Construct the request body according to the following instructions:
1919

2020
- Set the required `kind` property to `ProfessionalVoice`. The kind can't be changed later.
2121
- Optionally, set the `description` property for the project description. The project description can be changed later.
2222

23-
Make an HTTP PUT request using the URI as shown in the following [Projects_Create](/rest/api/speechapi/projects/create) example.
23+
Make an HTTP PUT request using the URI as shown in the following [Projects_Create](/rest/api/aiservices/speechapi/projects/create) example.
2424
- Replace `YourResourceKey` with your Speech resource key.
2525
- Replace `YourResourceRegion` with your Speech resource region.
2626
- Replace `ProjectId` with a project ID of your choice. The case sensitive ID must be unique within your Speech resource. The ID will be used in the project's URI and can't be changed later.
@@ -29,7 +29,7 @@ Make an HTTP PUT request using the URI as shown in the following [Projects_Creat
2929
curl -v -X PUT -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type: application/json" -d '{
3030
"description": "Project description",
3131
"kind": "ProfessionalVoice"
32-
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/projects/ProjectId?api-version=2023-12-01-preview"
32+
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/projects/ProjectId?api-version=2024-02-01-preview"
3333
```
3434

3535
You should receive a response body in the following format:

articles/ai-services/speech-service/includes/how-to/professional-voice/create-training-set/rest.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,14 @@ In this article, you [create a training set](#create-a-training-set) and get its
1515

1616
## Create a training set
1717

18-
To create a training set, use the [TrainingSets_Create](/rest/api/speechapi/training-sets/create) operation of the custom voice API. Construct the request body according to the following instructions:
18+
To create a training set, use the [TrainingSets_Create](/rest/api/aiservices/speechapi/training-sets/create) operation of the custom voice API. Construct the request body according to the following instructions:
1919

2020
- Set the required `projectId` property. See [create a project](../../../../professional-voice-create-project.md).
2121
- Set the required `voiceKind` property to `Male` or `Female`. The kind can't be changed later.
2222
- Set the required `locale` property. This should be the locale of the training set data. The locale of the training set should be the same as the locale of the [consent statement](../../../../professional-voice-create-consent.md). The locale can't be changed later. You can find the text to speech locale list [here](/azure/ai-services/speech-service/language-support?tabs=tts).
2323
- Optionally, set the `description` property for the training set description. The training set description can be changed later.
2424

25-
Make an HTTP PUT request using the URI as shown in the following [TrainingSets_Create](/rest/api/speechapi/training-sets/create) example.
25+
Make an HTTP PUT request using the URI as shown in the following [TrainingSets_Create](/rest/api/aiservices/speechapi/training-sets/create) example.
2626
- Replace `YourResourceKey` with your Speech resource key.
2727
- Replace `YourResourceRegion` with your Speech resource region.
2828
- Replace `JessicaTrainingSetId` with a training set ID of your choice. The case sensitive ID will be used in the training set's URI and can't be changed later.
@@ -33,7 +33,7 @@ curl -v -X PUT -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type:
3333
"projectId": "ProjectId",
3434
"locale": "en-US",
3535
"voiceKind": "Female"
36-
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/trainingsets/JessicaTrainingSetId?api-version=2023-12-01-preview"
36+
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/trainingsets/JessicaTrainingSetId?api-version=2024-02-01-preview"
3737
```
3838

3939
You should receive a response body in the following format:
@@ -53,7 +53,7 @@ You should receive a response body in the following format:
5353

5454
## Upload training set data
5555

56-
To upload a training set of audio and scripts, use the [TrainingSets_UploadData](/rest/api/speechapi/training-sets/upload-data) operation of the custom voice API.
56+
To upload a training set of audio and scripts, use the [TrainingSets_UploadData](/rest/api/aiservices/speechapi/training-sets/upload-data) operation of the custom voice API.
5757

5858
Before calling this API, please store recording and script files in Azure Blob. In the example below, recording files are https://contoso.blob.core.windows.net/voicecontainer/jessica300/*.wav, script files are
5959
https://contoso.blob.core.windows.net/voicecontainer/jessica300/*.txt.
@@ -70,7 +70,7 @@ Construct the request body according to the following instructions:
7070
- Set the required `extensions` property to the extensions of the script files.
7171
- Optionally, set the `prefix` property to set a prefix for the blob name.
7272

73-
Make an HTTP POST request using the URI as shown in the following [TrainingSets_UploadData](/rest/api/speechapi/training-sets/upload-data) example.
73+
Make an HTTP POST request using the URI as shown in the following [TrainingSets_UploadData](/rest/api/aiservices/speechapi/training-sets/upload-data) example.
7474
- Replace `YourResourceKey` with your Speech resource key.
7575
- Replace `YourResourceRegion` with your Speech resource region.
7676
- Replace `JessicaTrainingSetId` if you specified a different training set ID in the previous step.
@@ -92,13 +92,13 @@ curl -v -X POST -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type
9292
".txt"
9393
]
9494
}
95-
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/trainingsets/JessicaTrainingSetId:upload?api-version=2023-12-01-preview"
95+
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/trainingsets/JessicaTrainingSetId:upload?api-version=2024-02-01-preview"
9696
```
9797

98-
The response header contains the `Operation-Location` property. Use this URI to get details about the [TrainingSets_UploadData](/rest/api/speechapi/training-sets/upload-data) operation. Here's an example of the response header:
98+
The response header contains the `Operation-Location` property. Use this URI to get details about the [TrainingSets_UploadData](/rest/api/aiservices/speechapi/training-sets/upload-data) operation. Here's an example of the response header:
9999

100100
```HTTP 201
101-
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/284b7e37-f42d-4054-8fa9-08523c3de345?api-version=2023-12-01-preview
101+
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/284b7e37-f42d-4054-8fa9-08523c3de345?api-version=2024-02-01-preview
102102
Operation-Id: 284b7e37-f42d-4054-8fa9-08523c3de345
103103
```
104104

articles/ai-services/speech-service/includes/how-to/professional-voice/deploy-endpoint/rest.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ After you've successfully created and [trained](../../../../professional-voice-t
1616
1717
## Add a deployment endpoint
1818

19-
To create an endpoint, use the [Endpoints_Create](/rest/api/speechapi/endpoints/create) operation of the custom voice API. Construct the request body according to the following instructions:
19+
To create an endpoint, use the [Endpoints_Create](/rest/api/aiservices/speechapi/endpoints/create) operation of the custom voice API. Construct the request body according to the following instructions:
2020

2121
- Set the required `projectId` property. See [create a project](../../../../professional-voice-create-project.md).
2222
- Set the required `modelId` property. See [train a voice model](../../../../professional-voice-train-voice.md).
2323
- Set the required `description` property. The description can be changed later.
2424

25-
Make an HTTP PUT request using the URI as shown in the following [Endpoints_Create](/rest/api/speechapi/endpoints/create) example.
25+
Make an HTTP PUT request using the URI as shown in the following [Endpoints_Create](/rest/api/aiservices/speechapi/endpoints/create) example.
2626
- Replace `YourResourceKey` with your Speech resource key.
2727
- Replace `YourResourceRegion` with your Speech resource region.
2828
- Replace `EndpointId` with an endpoint ID of your choice. The ID must be a GUID and must be unique within your Speech resource. The ID will be used in the project's URI and can't be changed later.
@@ -32,7 +32,7 @@ curl -v -X PUT -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "Content-Type:
3232
"description": "Endpoint for Jessica voice",
3333
"projectId": "ProjectId",
3434
"modelId": "JessicaModelId",
35-
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/EndpointId?api-version=2023-12-01-preview"
35+
} ' "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/EndpointId?api-version=2024-02-01-preview"
3636
```
3737

3838
You should receive a response body in the following format:
@@ -52,10 +52,10 @@ You should receive a response body in the following format:
5252
}
5353
```
5454

55-
The response header contains the `Operation-Location` property. Use this URI to get details about the [Endpoints_Create](/rest/api/speechapi/endpoints/create) operation. Here's an example of the response header:
55+
The response header contains the `Operation-Location` property. Use this URI to get details about the [Endpoints_Create](/rest/api/aiservices/speechapi/endpoints/create) operation. Here's an example of the response header:
5656

5757
```HTTP 201
58-
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/284b7e37-f42d-4054-8fa9-08523c3de345?api-version=2023-12-01-preview
58+
Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/284b7e37-f42d-4054-8fa9-08523c3de345?api-version=2024-02-01-preview
5959
Operation-Id: 284b7e37-f42d-4054-8fa9-08523c3de345
6060
```
6161

@@ -83,15 +83,15 @@ To use a custom voice via [Speech Synthesis Markup Language (SSML)](../../../../
8383

8484
You can suspend or resume an endpoint, to limit spend and conserve resources that aren't in use. You won't be charged while the endpoint is suspended. When you resume an endpoint, you can continue to use the same endpoint URL in your application to synthesize speech.
8585

86-
To suspend an endpoint, use the [Endpoints_Suspend](/rest/api/speechapi/endpoints/suspend) operation of the custom voice API.
86+
To suspend an endpoint, use the [Endpoints_Suspend](/rest/api/aiservices/speechapi/endpoints/suspend) operation of the custom voice API.
8787

88-
Make an HTTP POST request using the URI as shown in the following [Endpoints_Suspend](/rest/api/speechapi/endpoints/suspend) example.
88+
Make an HTTP POST request using the URI as shown in the following [Endpoints_Suspend](/rest/api/aiservices/speechapi/endpoints/suspend) example.
8989
- Replace `YourResourceKey` with your Speech resource key.
9090
- Replace `YourResourceRegion` with your Speech resource region.
9191
- Replace `YourEndpointId` with the endpoint ID that you received when you created the endpoint.
9292

9393
```azurecli-interactive
94-
curl -v -X POST "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId:suspend?api-version=2023-12-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "content-type: application/json" -H "content-length: 0"
94+
curl -v -X POST "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId:suspend?api-version=2024-02-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "content-type: application/json" -H "content-length: 0"
9595
```
9696

9797
You should receive a response body in the following format:
@@ -113,15 +113,15 @@ You should receive a response body in the following format:
113113

114114
## Resume an endpoint
115115

116-
To suspend an endpoint, use the [Endpoints_Resume](/rest/api/speechapi/endpoints/resume) operation of the custom voice API.
116+
To suspend an endpoint, use the [Endpoints_Resume](/rest/api/aiservices/speechapi/endpoints/resume) operation of the custom voice API.
117117

118-
Make an HTTP POST request using the URI as shown in the following [Endpoints_Resume](/rest/api/speechapi/endpoints/resume) example.
118+
Make an HTTP POST request using the URI as shown in the following [Endpoints_Resume](/rest/api/aiservices/speechapi/endpoints/resume) example.
119119
- Replace `YourResourceKey` with your Speech resource key.
120120
- Replace `YourResourceRegion` with your Speech resource region.
121121
- Replace `YourEndpointId` with the endpoint ID that you received when you created the endpoint.
122122

123123
```azurecli-interactive
124-
curl -v -X POST "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId:resume?api-version=2023-12-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "content-type: application/json" -H "content-length: 0"
124+
curl -v -X POST "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId:resume?api-version=2024-02-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey" -H "content-type: application/json" -H "content-length: 0"
125125
```
126126

127127
You should receive a response body in the following format:
@@ -143,15 +143,15 @@ You should receive a response body in the following format:
143143

144144
## Delete an endpoint
145145

146-
To delete an endpoint, use the [Endpoints_Delete](/rest/api/speechapi/endpoints/delete) operation of the custom voice API.
146+
To delete an endpoint, use the [Endpoints_Delete](/rest/api/aiservices/speechapi/endpoints/delete) operation of the custom voice API.
147147

148-
Make an HTTP DELETE request using the URI as shown in the following [Endpoints_Delete](/rest/api/speechapi/endpoints/delete) example.
148+
Make an HTTP DELETE request using the URI as shown in the following [Endpoints_Delete](/rest/api/aiservices/speechapi/endpoints/delete) example.
149149
- Replace `YourResourceKey` with your Speech resource key.
150150
- Replace `YourResourceRegion` with your Speech resource region.
151151
- Replace `YourEndpointId` with the endpoint ID that you received when you created the endpoint.
152152

153153
```azurecli-interactive
154-
curl -v -X DELETE "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId?api-version=2023-12-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey"
154+
curl -v -X DELETE "https://YourResourceRegion.api.cognitive.microsoft.com/customvoice/endpoints/YourEndpointId?api-version=2024-02-01-preview" -H "Ocp-Apim-Subscription-Key: YourResourceKey"
155155
```
156156

157157
You should receive a response header with status code 204.

0 commit comments

Comments
 (0)