docs: update ACI docs for capability coupling and InvalidOptions - #246
Draft
Suraj Kumar (surajkumar-08) wants to merge 8 commits into
Draft
Suraj Kumar (surajkumar-08) wants to merge 8 commits into
Suraj Kumar (surajkumar-08) wants to merge 8 commits into
Conversation
Suraj Kumar (surajkumar-08)
marked this pull request as ready for review
April 2, 2026 06:51
Suraj Kumar (surajkumar-08)
marked this pull request as draft
April 2, 2026 06:51
Suraj Kumar (surajkumar-08)
force-pushed
the
update-aci-api-changes
branch
from
April 6, 2026 09:08
faf4eff to
d506515
Compare
John Kennedy (GrantMeStrength)
approved these changes
Jul 17, 2026
John Kennedy (GrantMeStrength)
left a comment
John Kennedy (GrantMeStrength)
left a comment
Collaborator
There was a problem hiding this comment.
LGTM — accurate improvement to Windows AI/ML documentation. Approved.
Collaborator
|
Copilot /review |
John Kennedy (GrantMeStrength)
previously approved these changes
Jul 17, 2026
John Kennedy (GrantMeStrength)
left a comment
John Kennedy (GrantMeStrength)
left a comment
Collaborator
There was a problem hiding this comment.
Reviewed ✅ — Documentation improvement looks good.
Copilot started reviewing on behalf of
John Kennedy (GrantMeStrength)
July 22, 2026 16:40
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the App Content Search (AppContentIndexer) documentation to reflect Windows App SDK 2.0.0-preview1 API behavior, and expands the tutorial with newer indexing/querying capabilities and additional end-to-end samples.
Changes:
- Updates version guidance and enriches content/search result explanations (including OCR text query matches).
- Adds/expands tutorial coverage for capability coupling, indexing status APIs, index lifecycle management, and intermediate/advanced scenarios.
- Improves/updates sample snippets to align with newer API surface (for example, region-of-interest output for image matches).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/apis/app-content-search.md | Updates overview/version availability text and adds a capability coupling section (currently a link-out). |
| docs/apis/app-content-search-tutorial.md | Adds prerequisites/version requirement, capability coupling guidance, OCR match handling, and multiple new scenario/sample sections. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| For guidance on how to integrate this feature into your app and use the ApplicationContentIndexer API, see: [Quickstart: App Content Search](app-content-search-tutorial.md) | ||
| For guidance on how to integrate this feature into your | ||
| app and use the ApplicationContentIndexer API, see: |
Comment on lines
+67
to
+71
| ## Capability coupling rules | ||
|
|
||
| Some index capabilities have dependency relationships. | ||
| For details on how `TextLexical`, `TextSemantic`, | ||
| `ImageOcr`, and `ImageSemantic` interact, see the |
| ``` | ||
|
|
||
| `QueryMatch` includes only `ContentId` and `TextOffset`/`TextLength`, not the matching text itself. It is your responsibility as the app developer to reference the original text. Query results are sorted by relevancy, with the top result being most relevant. Indexing occurs asynchronously, so queries may run on partial data. You can check the indexing status as outlined below. | ||
| `QueryMatch` includes only `ContentId` and `TextOffset`/`TextLength`, not the matching text itself. It is your responsibility as the app developer to reference the original text.For OCR query matches from indexed images, use AppManagedOcrTextQueryMatch.Fragment and AppManagedOcrTextQueryMatch.Subregion instead of text offsets. Query results are sorted by relevancy, with the top result being most relevant. Indexing occurs asynchronously, so queries may run on partial data. You can check the indexing status as outlined below. |
Comment on lines
+523
to
+524
| public async void WaitForIndexerIdleSample() | ||
| { |
Comment on lines
+733
to
+734
| public async void IndexCapabilitiesSample() | ||
| { |
|
|
||
| > [!TIP] | ||
| > When configuring index capabilities, be aware of | ||
| > [coupling rules](#capability-coupling-rules). |
Contributor
|
Learn Build status updates of commit 22eedff: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Updated the App Content Search tutorial to include additional features of the AppContentIndexer API, such as checking indexing status, updating and removing content, and deleting an index. - Added detailed examples for managing indexing operations, including handling content reindexing and using content regions for structured data. - Revised the capability coupling rules section for clarity and added a reference to the tutorial for detailed interactions between capabilities. - Expanded the App Content Search overview to clarify the return types of text and image queries, including the handling of OCR-extracted text.
…App Content Search tutorial
…or handling examples
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
… OCR typo - Unwrap hard-wrapped prose in Prerequisites, TIP/NOTE blocks, and capability-coupling sections of both ACI docs - Replace remaining ApplicationContentIndexer references with AppContentIndexer in app-content-search.md - Add missing space after 'original text.' and wrap AppManagedOcrTextQueryMatch.Fragment/.Subregion in backticks Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
John Kennedy (GrantMeStrength)
force-pushed
the
update-aci-api-changes
branch
from
September 11, 2026 16:41
22eedff to
e959718
Compare
Contributor
|
Learn Build status updates of commit e959718: ✅ Validation status: passed
For more details, please refer to the build report. |
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
|
Learn Build status updates of commit 2b6a523: ✅ Validation status: passed
For more details, please refer to the build report. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Updates AppContentIndexer (Semantic Search) documentation
for Windows App SDK 2.0.0-preview1 API changes.
What changed
docs/apis/app-content-search.md(overview)"2.0.0-preview1"
TextLexicalRequirementnow silentlysuppresses
TextSemanticRequirementImageSemanticRequirementnow silentlysuppresses
ImageOcrRequirementreturn
InvalidOptionsstatusWARNINGcallout about silent suppressionwith
Defaultsettingsdocs/apis/app-content-search-tutorial.md(tutorial)prerequisites
TIPcallout about capability coupling ruleswith cross-link to overview