-
Notifications
You must be signed in to change notification settings - Fork 196
Create Start-SPOSiteOpticalCharacterRecognitionBackfill.md #839
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
12d4318
Create Start-SPOSiteOpticalCharacterRecognitionBackfill.md
FarreltinF 1e83b41
Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md
FarreltinF ecbb5e6
Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOptica…
FarreltinF 01d34e3
Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOptica…
FarreltinF 1bb71bd
Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md
FarreltinF 7403d7e
Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md
FarreltinF fffa482
Update sharepoint-online.md
FarreltinF 1271c90
Update sharepoint/sharepoint-ps/sharepoint-online/Start-SPOSiteOptica…
FarreltinF 71281b4
Update Start-SPOSiteOpticalCharacterRecognitionBackfill.md
FarreltinF File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
73 changes: 73 additions & 0 deletions
73
...epoint-ps/sharepoint-online/Start-SPOSiteOpticalCharacterRecognitionBackfill.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| --- | ||
| 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 | ||
|
|
||
| > [!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. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ## SYNTAX | ||
|
|
||
| ```Powershell | ||
|
|
||
| Start-SPOSiteOpticalCharacterRecognitionBackfill [-Site] <string> | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| ``` | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| 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. | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## EXAMPLES | ||
|
|
||
| ### EXAMPLE 1 | ||
|
|
||
| ```powershell | ||
|
|
||
| Start-SPOSiteOpticalCharacterRecognitionBackfill -Site https://contosoenergy.sharepoint.com/sites/hr | ||
| ``` | ||
|
|
||
| Starts OCR process for all content that hasn't been processed before in the selected site. | ||
|
|
||
| ## PARAMETERS | ||
|
|
||
| ### -Site | ||
|
|
||
| Specifies the site URL where OCR process should be enabled on. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
|
|
||
| ```yaml | ||
| Type: String | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
| Parameter Sets: Default | ||
| Aliases: | ||
| Applicable: SharePoint Online | ||
|
|
||
| Required: True | ||
| Position: 1 | ||
| Default value: None | ||
| Accept pipeline input: False | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
| 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). | ||
|
FarreltinF marked this conversation as resolved.
Outdated
|
||
|
|
||
| ## RELATED LINKS | ||
|
|
||
| [Overview of optical character recognition in SharePoint](/en-us/microsoft-365/syntex/ocr-overview) | ||
|
|
||
| [Learn about optical character recognition in Microsoft Purview](/en-us/purview/ocr-learn-about?tabs=purview) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.