From 12d431828b06064643d9598c5fa3e714d41b7ea5 Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 12:44:02 -0700 Subject: [PATCH 1/9] Create Start-SPOSiteOpticalCharacterRecognitionBackfill.md Adding the new cmdlet documentation for the new feature OCR backfilling --- ...SiteOpticalCharacterRecognitionBackfill.md | 83 +++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md new file mode 100644 index 000000000..3d572ef3b --- /dev/null +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -0,0 +1,83 @@ +--- +external help file: sharepointonline.xml +Module Name: Microsoft.Online.SharePoint.PowerShell +online version: https://learn.microsoft.com/powershell/module/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill +applicable: SharePoint Online +title: Start-SPOSiteOpticalCharacterRecognitionBackfill +schema: 2.0.0 +author: FarreltinF +ms.author: fanyi +ms.reviewer: +--- + +# Start-SPOSiteOpticalCharacterRecognitionBackfill + +## SYNOPSIS + +> [!NOTE] +> This feature - Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization + +Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. + +## SYNTAX + +```Powershell + +Start-SPOSiteBackfillOCR [-Site] +``` + +## DESCRIPTION + +This command starts a job to trigger the Optical Character Recognition (OCR) process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. + +OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. + +## EXAMPLES + +### EXAMPLE 1 + +```powershell + +Start-SPOSiteBackfillOCR -Site https://contosoenergy.sharepoint.com/sites/hr +``` + +Starts OCR process for all content hasn't been processed before in the selected site. + +### EXAMPLE 2 + +```powershell + +$site = Get-SPOSIte -Identity https://contosoenergy.sharepoint.com/sites/hr +Start-SPOSiteBackfillOCR -Site $site +``` + +Start OCR process for all content hasn't been processed before in the selected site. + +## PARAMETERS + +### -Site + +Specifies the site URL where OCR process should be enabled on. + +```yaml +Type: String +Parameter Sets: Default +Aliases: +Applicable: SharePoint Online + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### CommonParameters + +This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). + +## RELATED LINKS + +[Overview of optical character recognition in SharePoint](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr-overview) + +[Learn about optical character recognition in Microsoft Purview](https://learn.microsoft.com/en-us/purview/ocr-learn-about?tabs=purview) From 1e83b416a86101dacff3634766e05fe46446b769 Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 13:07:55 -0700 Subject: [PATCH 2/9] Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md Update upon request --- ...SiteOpticalCharacterRecognitionBackfill.md | 28 ++++++------------- 1 file changed, 9 insertions(+), 19 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 3d572ef3b..8cf4cf723 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -14,8 +14,8 @@ ms.reviewer: ## SYNOPSIS -> [!NOTE] -> This feature - Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization +> [!important] +> Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. @@ -23,14 +23,14 @@ Initiates a job to trigger the Optical Character Recognition (OCR) process for a ```Powershell -Start-SPOSiteBackfillOCR [-Site] +Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] ``` ## DESCRIPTION -This command starts a job to trigger the Optical Character Recognition (OCR) process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. +This cmdlet starts a job to trigger the OCR process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. -OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. +OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. ## EXAMPLES @@ -38,20 +38,10 @@ OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the si ```powershell -Start-SPOSiteBackfillOCR -Site https://contosoenergy.sharepoint.com/sites/hr +Start-SPOSiteOpticalCharacterRecognitionBackfill -Site https://contosoenergy.sharepoint.com/sites/hr ``` -Starts OCR process for all content hasn't been processed before in the selected site. - -### EXAMPLE 2 - -```powershell - -$site = Get-SPOSIte -Identity https://contosoenergy.sharepoint.com/sites/hr -Start-SPOSiteBackfillOCR -Site $site -``` - -Start OCR process for all content hasn't been processed before in the selected site. +Starts OCR process for all content that hasn't been processed before in the selected site. ## PARAMETERS @@ -78,6 +68,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Overview of optical character recognition in SharePoint](https://learn.microsoft.com/en-us/microsoft-365/syntex/ocr-overview) +[Overview of optical character recognition in SharePoint](/en-us/microsoft-365/syntex/ocr-overview) -[Learn about optical character recognition in Microsoft Purview](https://learn.microsoft.com/en-us/purview/ocr-learn-about?tabs=purview) +[Learn about optical character recognition in Microsoft Purview](/en-us/purview/ocr-learn-about?tabs=purview) From ecbb5e61b6604891b9e81c26230181bef7dbc040 Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 14:06:02 -0700 Subject: [PATCH 3/9] Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md Co-authored-by: Jake Wilson <55420562+JWilson22@users.noreply.github.com> --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 8cf4cf723..01ccdec65 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -50,7 +50,7 @@ Starts OCR process for all content that hasn't been processed before in the sele Specifies the site URL where OCR process should be enabled on. ```yaml -Type: String +Type: SpoSitePipeBind Parameter Sets: Default Aliases: Applicable: SharePoint Online From 01d34e33244c7eb406d7b73c09297261dd16a6f5 Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 14:06:16 -0700 Subject: [PATCH 4/9] Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md Co-authored-by: Jake Wilson <55420562+JWilson22@users.noreply.github.com> --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 01ccdec65..f55000785 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -58,7 +58,7 @@ Applicable: SharePoint Online Required: True Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` From 1bb71bdbea1786ea8aea8c803e7b113e6b7d611d Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 14:10:02 -0700 Subject: [PATCH 5/9] Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index f55000785..7c134cd73 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -32,6 +32,9 @@ This cmdlet starts a job to trigger the OCR process for files that have either n OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. +> [!Note] +> Backfilling cancellation is currently under development. Once the cmdlet is triggered, the backfilling process cannot be stopped. Disabling OCR on the selected site will not cancel the ongoing backfilling session. + ## EXAMPLES ### EXAMPLE 1 From 7403d7ece7f07097108283ced4b81b1a22b4c95e Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 15:57:05 -0700 Subject: [PATCH 6/9] Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 7c134cd73..a4bdf4f0e 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -15,7 +15,7 @@ ms.reviewer: ## SYNOPSIS > [!important] -> Optical Character Recognition (OCR) is a pay-as-you-go feature, triggering this cmdlet will incur cost for your organization +> Optical Character Recognition (OCR) is a pay-as-you-go feature. Running this cmdlet will incur cost for your organization. Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. @@ -30,7 +30,7 @@ Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] This cmdlet starts a job to trigger the OCR process for files that have either never been OCR processed or have been modified since the last OCR process. This ensures all relevant content in the site is recognized and indexed for improved searchability and accessibility. -OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](/en-us/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. +OCR backfill can only be run on OCR-enabled sites. If OCR is disabled for the site, please enable OCR before proceeding with OCR backfilling. Refer to this [article](/microsoft-365/syntex/ocr) for instructions on enabling OCR on the selected site. > [!Note] > Backfilling cancellation is currently under development. Once the cmdlet is triggered, the backfilling process cannot be stopped. Disabling OCR on the selected site will not cancel the ongoing backfilling session. @@ -71,6 +71,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[Overview of optical character recognition in SharePoint](/en-us/microsoft-365/syntex/ocr-overview) +[Overview of optical character recognition in SharePoint](/microsoft-365/syntex/ocr-overview) -[Learn about optical character recognition in Microsoft Purview](/en-us/purview/ocr-learn-about?tabs=purview) +[Learn about optical character recognition in Microsoft Purview](/purview/ocr-learn-about?tabs=purview) From fffa482ca24ed30e0b9fbc88eeb6228965655f6b Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Tue, 18 Mar 2025 16:01:56 -0700 Subject: [PATCH 7/9] Update sharepoint-online.md Updated TOC --- .../sharepoint-ps/sharepoint-online/sharepoint-online.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md index c765581b7..fd6ade65d 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/sharepoint-online.md @@ -660,6 +660,10 @@ This cmdlet is not currently active in production and may be removed in the futu {{Manually Enter Start-SPOSiteContentMove Description Here}} +### [Start-SPOSiteOpticalCharacterRecognitionBackfill](Start-SPOSiteOpticalCharacterRecognitionBackfill.md) + +{{Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site.}} + ### [Start-SPOUserAndContentMove](Start-SPOUserAndContentMove.md) {{Manually Enter Start-SPOUserAndContentMove Description Here}} From 1271c9030ef95ba93827143768b0085a90c1eb2c Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Wed, 19 Mar 2025 10:46:58 -0700 Subject: [PATCH 8/9] Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md Co-authored-by: Sam M. Kabue --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index a4bdf4f0e..9c5922080 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -67,7 +67,7 @@ Accept wildcard characters: False ### CommonParameters -This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216). +This cmdlet supports the common parameters: `-Debug`, `-ErrorAction`, `-ErrorVariable`, `-InformationAction`, `-InformationVariable`, `-OutVariable`, `-OutBuffer`, `-PipelineVariable`, `-ProgressAction`, `-Verbose`, `-WarningAction`, and `-WarningVariable`. For more information, see [about_CommonParameters](/powershell/module/microsoft.powershell.core/about/about_commonparameters). ## RELATED LINKS From 71281b46dcf40c9a5c692fb6568a29965769b73f Mon Sep 17 00:00:00 2001 From: FarreltinF <111532171+FarreltinF@users.noreply.github.com> Date: Wed, 19 Mar 2025 10:48:45 -0700 Subject: [PATCH 9/9] Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md --- .../Start-SPOSiteOpticalCharacterRecognitionBackfill.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md index 9c5922080..699d98990 100644 --- a/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md +++ b/sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md @@ -17,13 +17,13 @@ ms.reviewer: > [!important] > Optical Character Recognition (OCR) is a pay-as-you-go feature. Running this cmdlet will incur cost for your organization. -Initiates a job to trigger the Optical Character Recognition (OCR) process for all files for the selected site. +Initiates a job to trigger the OCR process for all files for the selected site. ## SYNTAX ```Powershell -Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] +Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] ``` ## DESCRIPTION @@ -50,7 +50,7 @@ Starts OCR process for all content that hasn't been processed before in the sele ### -Site -Specifies the site URL where OCR process should be enabled on. +Specifies the site where OCR process should be enabled on. ```yaml Type: SpoSitePipeBind