Skip to content

Commit 154f10d

Browse files
ktoliverktoliver
authored
Merge pull request #83298 from magrefaat/patch-4
Update rest-api.md
2 parents 2b5f59e + 15f5166 commit 154f10d

File tree

2 files changed

+38
-18
lines changed
  • articles/cognitive-services/language-service
    • custom-classification/includes/quickstarts
    • custom-named-entity-recognition/includes/quickstarts

2 files changed

+38
-18
lines changed

‎articles/cognitive-services/language-service/custom-classification/includes/quickstarts/rest-api.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,14 @@ Use the following URL to create a project and import your tags file. Replace the
8181

8282
### Parameters
8383

84-
Use the following header to authenticate your request.
84+
Pass the following parameter with your request.
8585

8686
|Key|Explanation|Value|
8787
|--|--|--|
8888
|`api-version`| The API version used.| `2021-11-01-preview` |
8989

90+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
91+
9092
### Headers
9193

9294
Use the following header to authenticate your request.
@@ -161,12 +163,14 @@ Use the following URL when creating your API request. Replace the placeholder va
161163

162164
### Parameters
163165

164-
Use the following header to authenticate your request.
166+
Pass the following parameter with your request.
165167

166168
|Key|Explanation|Value|
167169
|--|--|--|
168170
|`api-version`| The API version used.| `2021-11-01-preview` |
169171

172+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
173+
170174
### Headers
171175

172176
Use the following header to authenticate your request.
@@ -194,7 +198,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
194198
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:
195199

196200
```rest
197-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}
201+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
198202
```
199203

200204
`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.
@@ -216,12 +220,14 @@ Use the following **GET** request to query the status of your model's training p
216220

217221
### Parameters
218222

219-
Use the following header to authenticate your request.
223+
Pass the following parameter with your request.
220224

221225
|Key|Explanation|Value|
222226
|--|--|--|
223227
|`api-version`| The API version used.| `2021-11-01-preview` |
224228

229+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
230+
225231
### Headers
226232

227233
Use the following header to authenticate your request.
@@ -282,12 +288,14 @@ Create a **PUT** request using the following URL, headers, and JSON body to star
282288

283289
### Parameters
284290

285-
Use the following header to authenticate your request.
291+
Pass the following parameter with your request.
286292

287293
|Key|Explanation|Value|
288294
|--|--|--|
289295
|`api-version`| The API version used.| `2021-11-01-preview` |
290296

297+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
298+
291299
### Headers
292300

293301
Use the following header to authenticate your request.
@@ -310,7 +318,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
310318
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:
311319

312320
```rest
313-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}
321+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
314322
```
315323

316324
`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.
@@ -332,12 +340,14 @@ Use the following **GET** request to query the status of your model's publishing
332340

333341
### Parameters
334342

335-
Use the following header to authenticate your request.
343+
Pass the following parameter with your request.
336344

337345
|Key|Explanation|Value|
338346
|--|--|--|
339347
|`api-version`| The API version used.| `2021-11-01-preview` |
340348

349+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
350+
341351
### Headers
342352

343353
Use the following header to authenticate your request.

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

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,14 @@ Use the following URL to create a project and import your tags file. Replace the
7878

7979
### Parameters
8080

81-
Use the following header to authenticate your request.
81+
Pass the following parameter with your request.
8282

8383
|Key|Explanation|Value|
8484
|--|--|--|
8585
|`api-version`| The API version used.| `2021-11-01-preview` |
8686

87+
To pass the parameter, add `?api-version=2021-11-01-preview` to the end of your request URL.
88+
8789
### Headers
8890

8991
Use the following header to authenticate your request.
@@ -192,11 +194,13 @@ Use the following URL when creating your API request. Replace the placeholder va
192194

193195
### Parameters
194196

195-
Use the following header to authenticate your request.
197+
Pass the following parameter with your request.
196198

197199
|Key|Explanation|Value|
198200
|--|--|--|
199-
|`api-version`| The API version used. | `2021-11-01-preview` |
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.
200204

201205
### Headers
202206

@@ -225,7 +229,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
225229
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:
226230

227231
```rest
228-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}
232+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/train/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
229233
```
230234

231235
`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.
@@ -246,11 +250,13 @@ Use the following **GET** request to query the status of your model's training p
246250

247251
### Parameters
248252

249-
Use the following header to authenticate your request.
253+
Pass the following parameter with your request.
250254

251255
|Key|Explanation|Value|
252256
|--|--|--|
253-
|`api-version`| The API version used. | `2021-11-01-preview` |
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.
254260

255261
### Headers
256262

@@ -311,11 +317,13 @@ Create a **PUT** request using the following URL, headers, and JSON body to star
311317

312318
### Parameters
313319

314-
Use the following header to authenticate your request.
320+
Pass the following parameter with your request.
315321

316322
|Key|Explanation|Value|
317323
|--|--|--|
318-
|`api-version`| The API version used. | `2021-11-01-preview` |
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.
319327

320328
### Headers
321329

@@ -339,7 +347,7 @@ Use the following JSON in your request. The model will be named `MyModel` once t
339347
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:
340348

341349
```rest
342-
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}
350+
{YOUR-ENDPOINT}/language/analyze-text/projects/{YOUR-PROJECT-NAME}/deployments/{DEPLOYMENT-NAME}/jobs/{JOB-ID}?api-version=xxxx-xx-xx-xxxxxxx
343351
```
344352

345353
`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.
@@ -361,11 +369,13 @@ Use the following **GET** request to query the status of your model's publishing
361369

362370
### Parameters
363371

364-
Use the following header to authenticate your request.
372+
Pass the following parameter with your request.
365373

366374
|Key|Explanation|Value|
367375
|--|--|--|
368-
|`api-version`| The API version used. | `2021-11-01-preview` |
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.
369379

370380
### Headers
371381

0 commit comments

Comments
 (0)