Skip to content

Commit cb911b6

Browse files
magrefaatmagrefaat
authored
Update rest-api.md
1 parent bad5de4 commit cb911b6

File tree

1 file changed

+8
-58
lines changed
  • articles/cognitive-services/language-service/custom-named-entity-recognition/includes/quickstarts

1 file changed

+8
-58
lines changed

‎articles/cognitive-services/language-service/custom-named-entity-recognition/includes/quickstarts/rest-api.md

Lines changed: 8 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -69,23 +69,13 @@ Create a **POST** request using the following URL, headers, and JSON body to cre
6969
Use the following URL to create a project and import your tags file. Replace the placeholder values below with your own values.
7070

7171
```rest
72-
{YOUR-ENDPOINT}/language/analyze-text/projects/{projectName}/:import.
72+
{YOUR-ENDPOINT}/language/analyze-text/projects/{projectName}/:import?api-version=2021-11-01-preview
7373
```
7474

7575
|Placeholder |Value | Example |
7676
|---------|---------|---------|
7777
|`{YOUR-ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
7878

79-
### Parameters
80-
81-
Pass the following parameter with your request.
82-
83-
|Key|Explanation|Value|
84-
|--|--|--|
85-
|`api-version`| The API version used.| `2021-11-01-preview` |
86-
87-
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
88-
8979
### Headers
9080

9181
Use the following header to authenticate your request.
@@ -184,24 +174,14 @@ ate a **POST** request using the following URL, headers, and JSON body to start
184174
Use the following URL when creating your API request. Replace the placeholder values below with your own values.
185175

186176
```rest
187-
{YOUR-ENDPOINT}/language/analyze-text/projects/{PROJECT-NAME}/:train
177+
{YOUR-ENDPOINT}/language/analyze-text/projects/{PROJECT-NAME}/:train?api-version=2021-11-01-preview
188178
```
189179

190180
|Placeholder |Value | Example |
191181
|---------|---------|---------|
192182
|`{YOUR-ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
193183
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
194184

195-
### Parameters
196-
197-
Pass the following parameter with your request.
198-
199-
|Key|Explanation|Value|
200-
|--|--|--|
201-
|`api-version`| The API version used.| `2021-11-01-preview` |
202-
203-
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
204-
205185
### Headers
206186

207187
Use the following header to authenticate your request.
@@ -229,7 +209,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
229209
Once you send your API request, you will receive a `202` response indicating success. In the response headers, extract the `location` value. It will be formatted like this:
230210

231211
```rest
232-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
212+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}?api-version=2021-11-01-preview
233213
```
234214

235215
`JOB-ID` is used to identify your request, since this operation is asynchronous. You will use this URL in the next step to get the training status.
@@ -239,7 +219,7 @@ Once you send your API request, you will receive a `202` response indicating suc
239219
Use the following **GET** request to query the status of your model's training process. You can use the URL you received from the previous step, or replace the placeholder values below with your own values.
240220

241221
```rest
242-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}
222+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}?api-version=2021-11-01-preview
243223
```
244224

245225
|Placeholder |Value | Example |
@@ -248,16 +228,6 @@ Use the following **GET** request to query the status of your model's training p
248228
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
249229
|`{JOB-ID}` | The ID for locating your model's training status. This is in the `location` header value you received in the previous step. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
250230

251-
### Parameters
252-
253-
Pass the following parameter with your request.
254-
255-
|Key|Explanation|Value|
256-
|--|--|--|
257-
|`api-version`| The API version used.| `2021-11-01-preview` |
258-
259-
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
260-
261231
### Headers
262232

263233
Use the following header to authenticate your request.
@@ -306,7 +276,7 @@ Once you send the request, you will get the following response.
306276
Create a **PUT** request using the following URL, headers, and JSON body to start deploying a custom NER model.
307277

308278
```rest
309-
{YOUR-ENDPOINT}/language/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}
279+
{YOUR-ENDPOINT}/language/analyze-text/projects/{PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}?api-version=2021-11-01-preview
310280
```
311281

312282
|Placeholder |Value | Example |
@@ -315,16 +285,6 @@ Create a **PUT** request using the following URL, headers, and JSON body to star
315285
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
316286
|`{DEPLOYMENT-NAME}` | The name of your deployment. This value is case-sensitive. | `prod` |
317287

318-
### Parameters
319-
320-
Pass the following parameter with your request.
321-
322-
|Key|Explanation|Value|
323-
|--|--|--|
324-
|`api-version`| The API version used.| `2021-11-01-preview` |
325-
326-
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
327-
328288
### Headers
329289

330290
Use the following header to authenticate your request.
@@ -347,7 +307,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
347307
Once you send your API request, you will receive a `202` response indicating success. In the response headers, extract the `location` value. It will be formatted like this:
348308

349309
```rest
350-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
310+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version=2021-11-01-preview
351311
```
352312

353313
`JOB-ID` is used to identify your request, since this operation is asynchronous. You will use this URL in the next step to get the publishing status.
@@ -357,7 +317,7 @@ Once you send your API request, you will receive a `202` response indicating suc
357317
Use the following **GET** request to query the status of your model's publishing process. You can use the URL you received from the previous step, or replace the placeholder values below with your own values.
358318

359319
```rest
360-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}
320+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version=2021-11-01-preview
361321
```
362322

363323
|Placeholder |Value | Example |
@@ -367,16 +327,6 @@ Use the following **GET** request to query the status of your model's publishing
367327
|`{DEPLOYMENT-NAME}` | The name of your deployment. This value is case-sensitive. | `prod` |
368328
|`{JOB-ID}` | The ID for locating your model's training status. This is in the `location` header value you received in the previous step. | `xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx` |
369329

370-
### Parameters
371-
372-
Pass the following parameter with your request.
373-
374-
|Key|Explanation|Value|
375-
|--|--|--|
376-
|`api-version`| The API version used.| `2021-11-01-preview` |
377-
378-
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
379-
380330
### Headers
381331

382332
Use the following header to authenticate your request.
@@ -558,4 +508,4 @@ Use the following header to authenticate your request.
558508

559509
|Key|Value|
560510
|--|--|
561-
|Ocp-Apim-Subscription-Key| The key to your resource. Used for authenticating your API requests.|
511+
|Ocp-Apim-Subscription-Key| The key to your resource. Used for authenticating your API requests.|

0 commit comments

Comments
 (0)