Skip to content

Commit 69c9cc7

Browse files
Merge pull request #5507 from laujan/440304-update-NER-custom-project
add content-type
2 parents 293283c + edf1678 commit 69c9cc7

File tree

1 file changed

+15
-17
lines changed
  • articles/ai-services/language-service/custom-named-entity-recognition/includes/rest-api

1 file changed

+15
-17
lines changed

articles/ai-services/language-service/custom-named-entity-recognition/includes/rest-api/create-project.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.topic: include
66
ms.date: 11/21/2024
77
ms.author: lajanuar
88
---
9-
To start creating a custom named entity recognition model, you need to create a project. Creating a project will let you label data, train, evaluate, improve, and deploy your models.
9+
To start creating a custom named entity recognition model, you need to create a project. Creating a project lets you label data, train, evaluate, improve, and deploy your models.
1010

1111
> [!NOTE]
1212
> The project name is case-sensitive for all operations.
@@ -15,7 +15,7 @@ Create a **PATCH** request using the following URL, headers, and JSON body to cr
1515

1616
### Request URL
1717

18-
Use the following URL to create a project. Replace the placeholder values below with your own values.
18+
Use the following URL to create a project. Replace the following placeholders with your own values.
1919

2020
```rest
2121
{Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version={API-VERSION}
@@ -25,20 +25,21 @@ Use the following URL to create a project. Replace the placeholder values below
2525
|---------|---------|---------|
2626
|`{ENDPOINT}` | The endpoint for authenticating your API request. | `https://<your-custom-subdomain>.cognitiveservices.azure.com` |
2727
|`{PROJECT-NAME}` | The name for your project. This value is case-sensitive. | `myProject` |
28-
|`{API-VERSION}` | The version of the API you are calling. The value referenced here is for the latest version released. See [Model lifecycle](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) to learn more about other available API versions. | `2022-05-01` |
28+
|`{API-VERSION}` | The version of the API you're calling. The value referenced is for the latest released version. For more information, see [Model lifecycle](../../../concepts/model-lifecycle.md#choose-the-model-version-used-on-your-data) to learn more about other available API versions. | `2022-05-01` |
2929

3030

31-
### Headers
31+
### Request headers
3232

3333
Use the following header to authenticate your request.
3434

35-
|Key|Value|
36-
|--|--|
37-
|`Ocp-Apim-Subscription-Key`| The key to your resource. Used for authenticating your API requests.|
35+
|Key|Required|Type|Value|
36+
|--|--|--|--|
37+
|`Ocp-Apim-Subscription-Key`|True|string| The key to your resource. Used for authenticating your API requests.|
38+
|`Content-Type`|True|string|**application/merge-patch+json**|
3839

39-
### Body
40+
### Request body
4041

41-
Use the following JSON in your request. Replace the placeholder values below with your own values.
42+
Use the following JSON in your request. Replace the following placeholders with your own values.
4243

4344
```json
4445
{
@@ -55,17 +56,14 @@ Use the following JSON in your request. Replace the placeholder values below wit
5556
|Key |Placeholder|Value | Example |
5657
|---------|---------|---------|--|
5758
| projectName | `{PROJECT-NAME}` | The name of your project. This value is case-sensitive. | `myProject` |
58-
| language | `{LANGUAGE-CODE}` | A string specifying the language code for the documents used in your project. If your project is a multilingual project, choose the language code of the majority of the documents. See [language support](../../language-support.md) to learn more about supported language codes. |`en-us`|
59+
| language | `{LANGUAGE-CODE}` | A string specifying the language code for the documents used in your project. If your project is a multilingual project, select the code for the language most frequently represented in the documents. See [language support](../../language-support.md) to learn more about supported language codes. |`en-us`|
5960
| projectKind | `CustomEntityRecognition` | Your project kind. | `CustomEntityRecognition` |
60-
| multilingual | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents. See [language support](../../language-support.md#multi-lingual-option) to learn more about multilingual support. | `true`|
61-
| storageInputContainerName | `{CONTAINER-NAME` | The name of your Azure storage container where you have uploaded your documents. | `myContainer` |
61+
| multilingual | `true`| A boolean value that enables you to have documents in multiple languages in your dataset and when your model is deployed you can query the model in any supported language (not necessarily included in your training documents). See [language support](../../language-support.md#multi-lingual-option) to learn more about multilingual support. | `true`|
62+
| storageInputContainerName | `{CONTAINER-NAME` | The name of your Azure storage container your documents were uploaded. | `myContainer` |
6263

64+
This request returns a 201 response, which means that the project is created.
6365

6466

65-
66-
This request will return a 201 response, which means that the project is created.
67-
68-
69-
This request will return an error if:
67+
This request returns an error if:
7068
* The selected resource doesn't have proper permission for the storage account.
7169

0 commit comments

Comments
 (0)