Skip to content

Commit 6df79d2

Browse files
authored
Merge pull request #223193 from PatrickFarley/cusvis-updates
[cog svcs] new api ref endpoint
2 parents f25bf01 + c819079 commit 6df79d2

File tree

8 files changed

+28
-28
lines changed

8 files changed

+28
-28
lines changed

articles/cognitive-services/Custom-Vision-Service/copy-move-projects.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.author: pafarley
1515

1616
After you've created and trained a Custom Vision project, you may want to copy your project to another resource. If your app or business depends on the use of a Custom Vision project, we recommend you copy your model to another Custom Vision account in another region. Then if a regional outage occurs, you can access your project in the region where it was copied.
1717

18-
The **[ExportProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)** and **[ImportProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee3)** APIs enable this scenario by allowing you to copy projects from one Custom Vision account into others. This guide shows you how to use these REST APIs with cURL. You can also use an HTTP request service like Postman to issue the requests.
18+
The **[ExportProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)** and **[ImportProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee3)** APIs enable this scenario by allowing you to copy projects from one Custom Vision account into others. This guide shows you how to use these REST APIs with cURL. You can also use an HTTP request service like Postman to issue the requests.
1919

2020
> [!TIP]
2121
> For an example of this scenario using the Python client library, see the [Move Custom Vision Project](https://github.com/Azure-Samples/custom-vision-move-project/tree/master/) repository on GitHub.
@@ -38,7 +38,7 @@ The process for copying a project consists of the following steps:
3838

3939
## Get the project ID
4040

41-
First call **[GetProjects](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddead)** to see a list of your existing Custom Vision projects and their IDs. Use the training key and endpoint of your source account.
41+
First call **[GetProjects](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddead)** to see a list of your existing Custom Vision projects and their IDs. Use the training key and endpoint of your source account.
4242

4343
```curl
4444
curl -v -X GET "{endpoint}/customvision/v3.3/Training/projects"
@@ -76,7 +76,7 @@ You'll get a `200\OK` response with a list of projects and their metadata in the
7676

7777
## Export the project
7878

79-
Call **[ExportProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)** using the project ID and your source training key and endpoint.
79+
Call **[ExportProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)** using the project ID and your source training key and endpoint.
8080

8181
```curl
8282
curl -v -X GET "{endpoint}/customvision/v3.3/Training/projects/{projectId}/export"
@@ -101,7 +101,7 @@ You'll get a `200/OK` response with metadata about the exported project and a re
101101
102102
## Import the project
103103

104-
Call **[ImportProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee3)** using your target training key and endpoint, along with the reference token. You can also give your project a name in its new account.
104+
Call **[ImportProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee3)** using your target training key and endpoint, along with the reference token. You can also give your project a name in its new account.
105105

106106
```curl
107107
curl -v -G -X POST "{endpoint}/customvision/v3.3/Training/projects/import"
@@ -139,4 +139,4 @@ You'll get a `200/OK` response with metadata about your newly imported project.
139139
## Next steps
140140

141141
In this guide, you learned how to copy and move a project between Custom Vision resources. Next, explore the API reference docs to see what else you can do with Custom Vision.
142-
* [REST API reference documentation](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)
142+
* [REST API reference documentation](/rest/api/custom-vision/)

articles/cognitive-services/Custom-Vision-Service/faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ sections:
7373
- question: |
7474
Can training images be exported with the tags that were added in the Custom Vision portal?
7575
answer: |
76-
Yes, you can use the [GetImages API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb4) to export with tags.
76+
Yes, you can use the [GetImages API](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb4) to export with tags.
7777
7878
- question: |
7979
I'm getting the message, `Can't train just yet. Reserved budget in hours is not enough to do advanced training`. What should I do?

articles/cognitive-services/Custom-Vision-Service/includes/quickstarts/rest-tutorial.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Copy the command to a text editor and make the following changes:
4242
* Replace `{endpoint}` with the endpoint that corresponds to your key.
4343
[!INCLUDE [subdomains-note](../../../../../includes/cognitive-services-custom-subdomains-note.md)]
4444
* Replace `{name}` with the name of your project.
45-
* Optionally set other URL parameters to configure what type of model your project will use. See the [CreatProject API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae) for options.
45+
* Optionally set other URL parameters to configure what type of model your project will use. See the [CreatProject API](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae) for options.
4646

4747
You'll receive a JSON response like the following. Save the `"id"` value of your project to a temporary location.
4848

@@ -99,7 +99,7 @@ You'll get a JSON response like the following. Save the `"id"` value of each tag
9999

100100
Next, download the sample images for this project. Save the contents of the [sample Images folder](https://github.com/Azure-Samples/cognitive-services-sample-data-files/tree/master/CustomVision/ImageClassification/Images) to your local device.
101101

102-
Use the following command to upload the images and apply tags; once for the "Hemlock" images, and separately for the "Japanese Cherry" images. See the [Create Images From Data](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb5) API for more options.
102+
Use the following command to upload the images and apply tags; once for the "Hemlock" images, and separately for the "Japanese Cherry" images. See the [Create Images From Data](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb5) API for more options.
103103

104104
:::code language="shell" source="~/cognitive-services-quickstart-code/curl/custom-vision/image-classifier.sh" ID="uploadimages":::
105105

@@ -118,7 +118,7 @@ This method trains the model on the tagged images you've uploaded and returns an
118118
* Replace `{projectId}` with your own project ID.
119119
* Replace `{tagArray}` with the ID of a tag.
120120
* Then, populate the body of the request with the binary data of the images you want to tag.
121-
* Optionally use other URL parameters. See the [Train Project](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee1) API for options.
121+
* Optionally use other URL parameters. See the [Train Project](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee1) API for options.
122122

123123
> [!TIP]
124124
> Train with selected tags
@@ -168,7 +168,7 @@ This method makes the current iteration of the model available for querying. You
168168
* Replace `{iterationId}` with the ID returned in the previous step.
169169
* Replace `{publishedName}` with the name you'd like to assign to your prediction model.
170170
* Replace `{predictionId}` with your own prediction resource ID. You can find the prediction resource ID on the resource's **Properties** tab in the Azure portal, listed as **Resource ID**.
171-
* Optionally use other URL parameters. See the [Publish Iteration](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fdded5) API.
171+
* Optionally use other URL parameters. See the [Publish Iteration](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fdded5) API.
172172

173173
## Test the prediction endpoint
174174

@@ -180,7 +180,7 @@ Finally, use this command to test your trained model by uploading a new image fo
180180
* Replace `{projectId}` with your own project ID.
181181
* Replace `{publishedName}` with the name you used in the previous step.
182182
* Add the binary data of your local image to the request body.
183-
* Optionally use other URL parameters. See the [Classify Image](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.1/operations/5eb37d24548b571998fde5f3) API.
183+
* Optionally use other URL parameters. See the [Classify Image](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.1/operations/5eb37d24548b571998fde5f3) API.
184184

185185
The returned JSON response will list each of the tags that the model applied to your image, along with probability scores for each tag.
186186

@@ -217,5 +217,5 @@ Now you've done every step of the image classification process using the REST AP
217217
> [Test and retrain a model](../../test-your-model.md)
218218
219219
* [What is Custom Vision?](../../overview.md)
220-
* [API reference documentation (training)](/dotnet/api/overview/azure/custom-vision)
221-
* [API reference documentation (prediction)](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae)
220+
* [API reference documentation (training)](/dotnet/api/overview/azure/cognitiveservices/client/customvision)
221+
* [API reference documentation (prediction)](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae)

articles/cognitive-services/Custom-Vision-Service/release-notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,6 @@ Bug fixes, including for ONNX export with special characters.
106106

107107
- Export to Android (TensorFlow) added, in addition to previously released export to iOS (CoreML.) This allows export of a trained compact model to be run offline in an application.
108108
- Added Retail and Landmark "compact" domains to enable model export for these domains.
109-
- Released version [1.2 Training API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/f2d62aa3b93843d79e948fe87fa89554/operations/5a3044ee08fa5e06b890f11f) and [1.1 Prediction API](https://southcentralus.dev.cognitive.microsoft.com/docs/services/57982f59b5964e36841e22dfbfe78fc1/operations/5a3044f608fa5e06b890f164). Updated APIs support model export, new Prediction operation that does not save images to "Predictions," and introduced batch operations to the Training API.
109+
- Released version [1.2 Training API](https://westus2.dev.cognitive.microsoft.com/docs/services/f2d62aa3b93843d79e948fe87fa89554/operations/5a3044ee08fa5e06b890f11f) and [1.1 Prediction API](https://westus2.dev.cognitive.microsoft.com/docs/services/57982f59b5964e36841e22dfbfe78fc1/operations/5a3044f608fa5e06b890f164). Updated APIs support model export, new Prediction operation that does not save images to "Predictions," and introduced batch operations to the Training API.
110110
- UX tweaks, including the ability to see which domain was used to train an iteration.
111111
- Updated [C# SDK and sample](https://github.com/Microsoft/Cognitive-CustomVision-Windows).

articles/cognitive-services/Custom-Vision-Service/storage-integration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ Now that you have the integration URLs, you can create a new Custom Vision proje
5858

5959
### Create new project
6060

61-
When you call the [CreateProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae) API, add the optional parameters _exportModelContainerUri_ and _notificationQueueUri_. Assign the URL values you got in the previous section.
61+
When you call the [CreateProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeae) API, add the optional parameters _exportModelContainerUri_ and _notificationQueueUri_. Assign the URL values you got in the previous section.
6262

6363
```curl
6464
curl -v -X POST "{endpoint}/customvision/v3.3/Training/projects?exportModelContainerUri={inputUri}&notificationQueueUri={inputUri}&name={inputName}"
@@ -96,7 +96,7 @@ If you receive a `200/OK` response, that means the URLs have been set up success
9696

9797
### Update existing project
9898

99-
To update an existing project with Azure storage feature integration, call the [UpdateProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb1) API, using the ID of the project you want to update.
99+
To update an existing project with Azure storage feature integration, call the [UpdateProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb1) API, using the ID of the project you want to update.
100100

101101
```curl
102102
curl -v -X PATCH "{endpoint}/customvision/v3.3/Training/projects/{projectId}"
@@ -152,7 +152,7 @@ In your notification queue, you should see a test notification in the following
152152

153153
## Get event notifications
154154

155-
When you're ready, call the [TrainProject](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee1) API on your project to do an ordinary training operation.
155+
When you're ready, call the [TrainProject](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc7548b571998fddee1) API on your project to do an ordinary training operation.
156156

157157
In your Storage notification queue, you'll receive a notification once training finishes:
158158

@@ -173,7 +173,7 @@ The `"trainingStatus"` field may be either `"TrainingCompleted"` or `"TrainingFa
173173

174174
## Get model export backups
175175

176-
When you're ready, call the [ExportIteration](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddece) API to export a trained model into a specified platform.
176+
When you're ready, call the [ExportIteration](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddece) API to export a trained model into a specified platform.
177177

178178
In your designated storage container, a backup copy of the exported model will appear. The blob name will have the format:
179179

@@ -202,5 +202,5 @@ The `"exportStatus"` field may be either `"ExportCompleted"` or `"ExportFailed"`
202202
## Next steps
203203

204204
In this guide, you learned how to copy and back up a project between Custom Vision resources. Next, explore the API reference docs to see what else you can do with Custom Vision.
205-
* [REST API reference documentation (training)](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)
206-
* [REST API reference documentation (prediction)](https://southcentralus.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.1/operations/5eb37d24548b571998fde5f3)
205+
* [REST API reference documentation (training)](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3/operations/5eb0bcc6548b571998fddeb3)
206+
* [REST API reference documentation (prediction)](https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.1/operations/5eb37d24548b571998fde5f3)

articles/cognitive-services/Custom-Vision-Service/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,9 @@ items:
8585
- name: Reference
8686
items:
8787
- name: Custom Vision Training API
88-
href: https://go.microsoft.com/fwlink/?linkid=865446
88+
href: https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Training_3.3
8989
- name: Custom Vision Prediction API
90-
href: https://go.microsoft.com/fwlink/?linkid=865445
90+
href: https://westus2.dev.cognitive.microsoft.com/docs/services/Custom_Vision_Prediction_3.1
9191
- name: SDKs
9292
items:
9393
- name: .NET

0 commit comments

Comments
 (0)