Skip to content

Commit 7984940

Browse files
authored
Merge pull request #284102 from MicrosoftDocs/main
8/8/2024 PM Publish
2 parents c7369f4 + ee8f08c commit 7984940

File tree

258 files changed

+9853
-9101
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

258 files changed

+9853
-9101
lines changed

.openpublishing.redirection.azure-monitor.json

Lines changed: 6882 additions & 6868 deletions
Large diffs are not rendered by default.

articles/ai-services/custom-vision-service/copy-move-projects.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.author: pafarley
1414

1515
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 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.
1616

17-
The **[ExportProject](/rest/api/customvision/training/projects/export?view=rest-customvision-training-v3.3&tabs=HTTP)** and **[ImportProject](/rest/api/customvision/training/projects/import?view=rest-customvision-training-v3.3&tabs=HTTP)** 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 the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) for Visual Studio Code, to issue the requests.
17+
The **[ExportProject](/rest/api/customvision/projects/export)** and **[ImportProject](/rest/api/customvision/projects/import)** 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 the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) for Visual Studio Code, to issue the requests.
1818

1919
> [!TIP]
2020
> 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.
@@ -39,7 +39,7 @@ The process for copying a project consists of the following steps:
3939

4040
## Get the project ID
4141

42-
First call **[GetProjects](/rest/api/customvision/training/projects/get?view=rest-customvision-training-v3.3&tabs=HTTP)** to see a list of your existing Custom Vision projects and their IDs. Use the training key and endpoint of your source account.
42+
First call **[GetProjects](/rest/api/customvision/projects/get)** to see a list of your existing Custom Vision projects and their IDs. Use the training key and endpoint of your source account.
4343

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

7878
## Export the project
7979

80-
Call **[ExportProject](/rest/api/customvision/training/projects/export?view=rest-customvision-training-v3.3&tabs=HTTP)** using the project ID and your source training key and endpoint.
80+
Call **[ExportProject](/rest/api/customvision/projects/export)** using the project ID and your source training key and endpoint.
8181

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

105-
Call **[ImportProject](/rest/api/customvision/training/projects/import?view=rest-customvision-training-v3.3&tabs=HTTP)** using your target training key and endpoint, along with the reference token. You can also give your project a name in its new account.
105+
Call **[ImportProject](/rest/api/customvision/projects/import)** using your target training key and endpoint, along with the reference token. You can also give your project a name in its new account.
106106

107107
```curl
108108
curl -v -G -X POST "{endpoint}/customvision/v3.3/Training/projects/import"

articles/ai-services/custom-vision-service/export-delete-data.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ ms.custom: cogserv-non-critical-vision
1515

1616
# View or delete user data in Custom Vision
1717

18-
Custom Vision collects user data to operate the service, but customers have full control to viewing and delete their data using the Custom Vision [Training APIs](https://go.microsoft.com/fwlink/?linkid=865446).
18+
Custom Vision collects user data to operate the service, but customers have full control to viewing and delete their data using the Custom Vision [Training APIs](/rest/api/customvision/train-project).
1919

2020
[!INCLUDE [GDPR-related guidance](~/reusable-content/ce-skilling/azure/includes/gdpr-intro-sentence.md)]
2121

2222
To learn how to view or delete different kinds of user data in Custom Vision, see the following table:
2323

2424
| Data | View operation | Delete operation |
2525
| ---- | ---------------- | ---------------- |
26-
| Account info (Keys) | [GetAccountInfo](https://go.microsoft.com/fwlink/?linkid=865446) | Delete using Azure portal (for Azure Subscriptions). Or use **Delete Your Account** button in [CustomVision.ai](https://customvision.ai) settings page (for Microsoft Account Subscriptions) |
27-
| Iteration details | [GetIteration](https://go.microsoft.com/fwlink/?linkid=865446) | [DeleteIteration](https://go.microsoft.com/fwlink/?linkid=865446) |
28-
| Iteration performance details | [GetIterationPerformance](https://go.microsoft.com/fwlink/?linkid=865446) | [DeleteIteration](https://go.microsoft.com/fwlink/?linkid=865446) |
29-
| List of iterations | [GetIterations](https://go.microsoft.com/fwlink/?linkid=865446) | [DeleteIteration](https://go.microsoft.com/fwlink/?linkid=865446) |
30-
| Projects and project details | [GetProject](https://go.microsoft.com/fwlink/?linkid=865446) and [GetProjects](https://go.microsoft.com/fwlink/?linkid=865446) | [DeleteProject](https://go.microsoft.com/fwlink/?linkid=865446) |
31-
| Image tags | [GetTag](https://go.microsoft.com/fwlink/?linkid=865446) and [GetTags](https://go.microsoft.com/fwlink/?linkid=865446) | [DeleteTag](https://go.microsoft.com/fwlink/?linkid=865446) |
32-
| Images | [GetTaggedImages](https://go.microsoft.com/fwlink/?linkid=865446) (provides uri for image download) and [GetUntaggedImages](https://go.microsoft.com/fwlink/?linkid=865446) (provides uri for image download) | [DeleteImages](https://go.microsoft.com/fwlink/?linkid=865446) |
33-
| Exported iterations | [GetExports](https://go.microsoft.com/fwlink/?linkid=865446) | Deleted upon account deletion |
26+
| Account info (Keys) | [GetAccountInfo](/rest/api/aiservices/accountmanagement/accounts/get) | Delete using Azure portal (for Azure Subscriptions). Or use **Delete Your Account** button in [CustomVision.ai](https://customvision.ai) settings page (for Microsoft Account Subscriptions) |
27+
| Iteration details | [GetIteration](/rest/api/customvision/get-iteration) | [DeleteIteration](/rest/api/customvision/delete-iteration) |
28+
| Iteration performance details | [GetIterationPerformance](/rest/api/customvision/get-iteration-performance) | [DeleteIteration](/rest/api/customvision/delete-iteration) |
29+
| List of iterations | [GetIterations](/rest/api/customvision/get-iterations) | [DeleteIteration](/rest/api/customvision/delete-iteration) |
30+
| Projects and project details | [GetProject](/rest/api/customvision/get-project) and [GetProjects](/rest/api/customvision/get-projects) | [DeleteProject](/rest/api/customvision/delete-project) |
31+
| Image tags | [GetTag](/rest/api/customvision/get-tag) and [GetTags](/rest/api/customvision/get-tags) | [DeleteTag](/rest/api/customvision/delete-tag) |
32+
| Images | [GetTaggedImages](/rest/api/customvision/get-tagged-images) (provides uri for image download) and [GetUntaggedImages](/rest/api/customvision/get-untagged-images) (provides uri for image download) | [DeleteImages](/rest/api/customvision/delete-images) |
33+
| Exported iterations | [GetExports](/rest/api/customvision/get-exports) | Deleted upon account deletion |

articles/ai-services/custom-vision-service/faq.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ sections:
7878
- question: |
7979
Can training images be exported with the tags that were added in the Custom Vision portal?
8080
answer: |
81-
Yes, you can use the [GetImages API](/rest/api/customvision/training/images/list?view=rest-customvision-training-v3.3&tabs=HTTP) to export with tags.
81+
Yes, you can use the [GetImages API](/rest/api/customvision/get-images) to export with tags.
8282
8383
- question: |
8484
How can I write logs on this service?

articles/ai-services/custom-vision-service/includes/quickstarts/rest-tutorial.md

Lines changed: 5 additions & 5 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](/rest/api/customvision/training/projects/create?view=rest-customvision-training-v3.3&tabs=HTTP) for options.
45+
* Optionally set other URL parameters to configure what type of model your project will use. See the [CreatProject API](/rest/api/customvision/create-project) 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](/rest/api/customvision/training/images/create-from-data?view=rest-customvision-training-v3.3&tabs=HTTP) 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](/rest/api/customvision/create-images-from-data) 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](/rest/api/customvision/training/projects/train?view=rest-customvision-training-v3.3&tabs=HTTP) API for options.
121+
* Optionally use other URL parameters. See the [Train Project](/rest/api/customvision/train-project) 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](/rest/api/customvision/training/iterations/publish?view=rest-customvision-training-v3.3&tabs=HTTP) API.
171+
* Optionally use other URL parameters. See the [Publish Iteration](/rest/api/customvision/publish-iteration) 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](/rest/api/customvision/training/train-project/train-project) API.
183+
* Optionally use other URL parameters. See the [Classify Image](/rest/api/customvision/train-project/train-project) 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

articles/ai-services/custom-vision-service/limits-and-quotas.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ There are two tiers of keys for the Custom Vision service. You can sign up for a
2828
|How long prediction images stored|30 days|30 days|
2929
|[Prediction](/rest/api/customvision/predictions) operations with storage (Transactions Per Second)|2|10|
3030
|[Prediction](/rest/api/customvision/predictions) operations without storage (Transactions Per Second)|2|20|
31-
|[TrainProject](https://go.microsoft.com/fwlink/?linkid=865446) (API calls Per Second)|2|10|
32-
|[Other API calls](https://go.microsoft.com/fwlink/?linkid=865446) (Transactions Per Second)|10|10|
31+
|[TrainProject](/rest/api/customvision/train-project/train-project) (API calls Per Second)|2|10|
32+
|[Other API calls](/rest/api/custom-vision) (Transactions Per Second)|10|10|
3333
|Accepted image types|jpg, png, bmp, gif|jpg, png, bmp, gif|
3434
|Min image height/width in pixels|256 (see note)|256 (see note)|
3535
|Max image height/width in pixels|10,240|10,240|

articles/ai-services/custom-vision-service/select-domain.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.author: pafarley
1515

1616
This guide shows you how to select a domain for your project in the Custom Vision Service.
1717

18-
From the **settings** tab of your project on the Custom Vision web portal, you can select a model domain for your project. You'll want to choose the domain that's closest to your use case scenario. If you're accessing Custom Vision through a client library or REST API, you'll need to specify a domain ID when creating the project. You can get a list of domain IDs with [Get Domains](/rest/api/customvision/training/domains/list?view=rest-customvision-training-v3.3&tabs=HTTP). Or, use the table below.
18+
From the **settings** tab of your project on the Custom Vision web portal, you can select a model domain for your project. You'll want to choose the domain that's closest to your use case scenario. If you're accessing Custom Vision through a client library or REST API, you'll need to specify a domain ID when creating the project. You can get a list of domain IDs with [Get Domains](/rest/api/customvision/get-domains). Or, use the table below.
1919

2020
## Image Classification domains
2121

articles/ai-services/custom-vision-service/storage-integration.md

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

6262
#### [Create a new project](#tab/create)
6363

64-
When you call the [CreateProject](/rest/api/customvision/training/projects/create?view=rest-customvision-training-v3.3&tabs=HTTP) API, add the optional parameters _exportModelContainerUri_ and _notificationQueueUri_. Assign the URL values you got in the previous section.
64+
When you call the [CreateProject](/rest/api/customvision/create-project) API, add the optional parameters _exportModelContainerUri_ and _notificationQueueUri_. Assign the URL values you got in the previous section.
6565

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

100100
#### [Update an existing project](#tab/update)
101101

102-
To update an existing project with Azure storage feature integration, call the [UpdateProject](/rest/api/customvision/training/projects/update?view=rest-customvision-training-v3.3&tabs=HTTP) API, using the ID of the project you want to update.
102+
To update an existing project with Azure storage feature integration, call the [UpdateProject](/rest/api/customvision/update-project) API, using the ID of the project you want to update.
103103

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

158158
## Get event notifications
159159

160-
When you're ready, call the [TrainProject](/rest/api/customvision/training/projects/train?view=rest-customvision-training-v3.3&tabs=HTTP) API on your project to do an ordinary training operation.
160+
When you're ready, call the [TrainProject](/rest/api/customvision/train-project) API on your project to do an ordinary training operation.
161161

162162
In your Storage notification queue, you'll receive a notification once training finishes:
163163

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

179179
## Get model export backups
180180

181-
When you're ready, call the [ExportIteration](/rest/api/customvision/training/iterations/export?view=rest-customvision-training-v3.3&tabs=HTTP) API to export a trained model into a specified platform.
181+
When you're ready, call the [ExportIteration](/rest/api/customvision/export-iteration) API to export a trained model into a specified platform.
182182

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

@@ -207,5 +207,5 @@ The `"exportStatus"` field may be either `"ExportCompleted"` or `"ExportFailed"`
207207
## Next steps
208208

209209
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.
210-
* [REST API reference documentation (training)](/rest/api/customvision/training/operation-groups?view=rest-customvision-training-v3.3)
210+
* [REST API reference documentation (training)](/rest/api/customvision/train-project)
211211
* [REST API reference documentation (prediction)](/rest/api/customvision/predictions)

articles/ai-services/document-intelligence/concept-read.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ description: Extract print and handwritten text from scanned and digital documen
55
author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
8-
ms.custom:
9-
- ignite-2023
108
ms.topic: conceptual
119
ms.date: 08/07/2024
1210
ms.author: lajanuar
@@ -122,7 +120,7 @@ The searchable PDF capability enables you to convert an analog PDF, such as scan
122120
> [!IMPORTANT]
123121
>
124122
> * Currently, the searchable PDF capability is only supported by Read OCR model `prebuilt-read`. When using this feature, please specify the `modelId` as `prebuilt-read`, as other model types will return error for this preview version.
125-
> * Searchable PDF is included with the 2024-07-31-preview `prebuilt-read` model with no usage cost for general PDF consumption.
123+
> * Searchable PDF is included with the 2024-07-31-preview `prebuilt-read` model with no additional cost for generating a searchable PDF output.
126124
127125
### Use searchable PDF
128126

@@ -135,7 +133,7 @@ POST /documentModels/prebuilt-read:analyze?output=pdf
135133
202
136134
```
137135

138-
Once the `Analyze` operation is complete, make a `GET` request to retrieve the `Analyze` operation results.
136+
Poll for completion of the `Analyze` operation. Once the operation is complete, issue a `GET` request to retrieve the PDF format of the `Analyze` operation results.
139137

140138
Upon successful completion, the PDF can be retrieved and downloaded as `application/pdf`. This operation allows direct downloading of the embedded text form of PDF instead of Base64-encoded JSON.
141139

0 commit comments

Comments
 (0)