Skip to content

Commit 400d80d

Browse files
committed
🐞📚 fix errors with frontmatter for syntex docs
- validation errors with `ms.prod` frontmatter prop: - invalid value set - value for `ms.service` used as `ms.prod` value - can't have both `ms.prod` & `ms.service`: mutually exclusive - removed value from docs & moved to docfx.json for mass set - added missing `ms.date` - fixes to other docs to account for above changes
1 parent 6e50caf commit 400d80d

20 files changed

+123
-160
lines changed

docs/apis/syntex/rest-applymodel-method.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
---
22
title: Batch apply model
3+
description: Use REST API to apply a document understanding model to one or more libraries.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to apply a document understanding model to one or more libraries.
1413
---
15-
1614
# Batch Apply model
1715

1816
Applies (or syncs) a trained document understanding model to one or more libraries (see [example](rest-applymodel-method.md#examples)).
@@ -72,7 +70,7 @@ None
7270
|--------|-------|------------|
7371
|StatusCode|int|The HTTP status code.|
7472
|ErrorMessage|string|The error message which tells what's wrong when apply the model to the document library.|
75-
|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.|
73+
|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.|
7674

7775
### MachineLearningPublicationEntityData
7876

docs/apis/syntex/rest-batchdelete-method.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: BatchDelete
3+
description: Use REST API to remove an applied document understanding model from one or more libraries.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to remove an applied document understanding model from one or more libraries.
1413
---
1514

1615
# BatchDelete
@@ -70,7 +69,7 @@ None
7069
|--------|-------|------------|
7170
|StatusCode|int|The HTTP status code.|
7271
|ErrorMessage|string|The error message which tells what's wrong when apply the model to the document library.|
73-
|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.|
72+
|Publication|MachineLearningPublicationEntityData|It specifies the model info and the target document library.|
7473

7574
### MachineLearningPublicationEntityData
7675

@@ -90,16 +89,16 @@ In this sample, the ID of the Contoso Contract document understanding model is `
9089
#### Sample request
9190

9291
```HTTP
93-
{
94-
"publications": [
95-
{
96-
"ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc",
97-
"TargetSiteUrl": "https://constco.sharepoint-df.com/sites/docsite",
98-
"TargetWebServerRelativeUrl": "/sites/docsite ",
99-
"TargetLibraryServerRelativeUrl": "/sites/dcocsite/joedcos"
100-
}
101-
]
102-
}
92+
{
93+
"publications": [
94+
{
95+
"ModelUniqueId": "7645e69d-21fb-4a24-a17a-9bdfa7cb63dc",
96+
"TargetSiteUrl": "https://constco.sharepoint-df.com/sites/docsite",
97+
"TargetWebServerRelativeUrl": "/sites/docsite ",
98+
"TargetLibraryServerRelativeUrl": "/sites/dcocsite/joedcos"
99+
}
100+
]
101+
}
103102
```
104103

105104
#### Sample response

docs/apis/syntex/rest-createclassificationrequest.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: Create file classification request
3+
description: Use REST API to create a request to classify one or more files using a trained document understanding model.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to create a request to classify one or more files using a trained document understanding model.
1413
---
1514

1615
# Create file classification request

docs/apis/syntex/rest-createfolderclassificationrequest.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: Create folder classification request
3+
description: Use REST API to create a request to classify an entire folder using a trained document understanding model.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to create a request to classify an entire folder using a trained document understanding model.
1413
---
1514

1615
# Create folder classification request
@@ -78,7 +77,7 @@ None
7877
"TargetSiteId": "f686e63b-aba7-48e5-97c7-68c4c1df292f",
7978
"TargetWebId": "66d6b64d-6f88-4dd9-b3db-47e6f00c53e8",
8079
"TargetUniqueId": "e6cff8b7-c90c-4564-b5b8-033449090932",
81-
"IsFolder": true
80+
"IsFolder": true
8281
}
8382
```
8483

docs/apis/syntex/rest-createmodel-method.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: Create model
3+
description: Use REST API to create a model and its associated content type.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to create a model and its associated content type.
1413
---
1514

1615
# Create model

docs/apis/syntex/rest-getbytitle-method.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: GetByTitle
3+
description: Use REST API to get or update information about a SharePoint Syntex document understanding model using the model title.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: article
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to get or update information about a SharePoint Syntex document understanding model using the model title.
1413
---
1514

1615
# GetByTitle

docs/apis/syntex/rest-getbyuniqueid-method.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: GetByUniqueId
3+
description: Use REST API to get or update information about a SharePoint Syntex document understanding model.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to get or update information about a SharePoint Syntex document understanding model.
1413
---
1514

1615
# GetByUniqueId
@@ -23,7 +22,7 @@ Gets or updates information about a SharePoint Syntex document understanding mod
2322
GET /_api/machinelearning/models/getbyuniqueid('{modelUniqueId}') HTTP/1.1
2423
```
2524

26-
This same method can be used for deleting a model, too.
25+
This same method can be used for deleting a model, too.
2726

2827
```HTTP
2928
DELETE /_api/machinelearning/models/getbyuniqueid('{modelUniqueId}') HTTP/1.1

docs/apis/syntex/rest-getmodelandlibraryinfo.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: Get model and library info
3+
description: Use REST API to get information about a model and the library where it has been applied.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to get information about a model and the library where it has been applied.
1413
---
1514

1615
# Get model and library information

docs/apis/syntex/rest-updatemodelsettings-method.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
---
22
title: UpdateModelSettings
3+
description: Use REST API to update available models settings for a SharePoint Syntex document understanding model.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
search.appverid:
1111
ms.collection: m365initiative-syntex
1212
ms.localizationpriority: high
13-
description: Use REST API to update available models settings for a SharePoint Syntex document understanding model.
1413
---
1514

1615
# UpdateModelSettings

docs/apis/syntex/syntex-model-rest-api.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,30 @@
11
---
22
title: SharePoint Syntex document understanding model REST API
3+
description: Overview of the SharePoint Syntex document understanding model REST API.
4+
ms.date: 09/23/2022
35
ms.author: chucked
46
author: chuckedmonson
57
manager: pamgreen
68
ms.reviewer: ssquires
79
audience: admin
810
ms.topic: reference
9-
ms.prod: microsoft-365-enterprise
10-
ms.date: 04/06/2022
11-
search.appverid:
1211
ms.collection: m365initiative-syntex
1312
ms.localizationpriority: high
14-
description: Overview of the SharePoint Syntex document understanding model REST API.
1513
---
1614

1715
# SharePoint Syntex document understanding model REST API
1816

19-
You can use the SharePoint REST interface to create a document understanding model, apply or remove the model to one or more libraries, and obtain or update information about the model.
17+
You can use the SharePoint REST interface to create a document understanding model, apply or remove the model to one or more libraries, and obtain or update information about the model.
2018

21-
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option.
19+
The SharePoint Online (and SharePoint 2016 and later on-premises) REST service supports combining multiple requests into a single call to the service by using the OData $batch query option.
2220

2321
For details and links to code samples, see [Make batch requests with the REST APIs](/sharepoint/dev/sp-add-ins/make-batch-requests-with-the-rest-apis).
2422

2523
## Prerequisites
2624

2725
Before you get started, make sure that you're familiar with the following:
2826

29-
- [Get to know the SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service)
27+
- [Get to know the SharePoint REST service](/sharepoint/dev/sp-add-ins/get-to-know-the-sharepoint-rest-service)
3028
- [Complete basic operations using SharePoint REST endpoints](/sharepoint/dev/sp-add-ins/complete-basic-operations-using-sharepoint-rest-endpoints)
3129

3230
## REST commands
@@ -57,4 +55,3 @@ The remove model method just removes the model from one or more libraries where
5755
## See also
5856

5957
[Document understanding overview](/microsoft-365/contentunderstanding/document-understanding-overview)
60-

0 commit comments

Comments
 (0)