windows-ai-electron/llms.txt at main · microsoft/windows-ai-electron · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# Windows AI Addon for Electron

> Leverage Windows AI capabilities directly from your app's JavaScript

## Description

The Windows AI Addon for Electron (`@microsoft/windows-ai-electron`) is a Node.js native addon that provides access to the Windows AI APIs, enabling Electron applications to leverage Windows AI capabilities directly from JavaScript.

This package creates JavaScript projections for the native Windows AI APIs, allowing developers to use on-device AI features like text summarization, text rewriting, image super resolution, and more in their Electron applications.

**Status:** Public Preview - experimental and in active development.

## Key Features

- **Text Summarization** - Summarize long text or conversations using on-device AI
- **Text Rewriting** - Rewrite text with different tones (professional, casual, friendly, etc.)
- **Text Generation** - Generate AI responses using the local Phi Silica model (requires Limited Access Feature token)
- **Image Processing** - Super resolution, object erase, and background blur for images
- **Content Safety** - Content moderation and severity filtering

## Prerequisites

- Copilot+ PC
- Windows 11 (Windows Insider Preview build 26120.3073 or later)
- Node.js 18.x or later
- Visual Studio 2022 with C++ build tools
- Python 3.x

## Getting Started

### Quick Start

1. Create an Electron app or use an existing one
2. Install the package:
   ```bash
   npm i @microsoft/windows-ai-electron
   ```
3. Install the CLI tool as a dev dependency:
   ```bash
   npm i @microsoft/winappcli -D
   ```
4. Initialize Windows API support:
   ```bash
   npx winapp init
   ```
5. Add `systemAIModels` capability to `appxmanifest.xml`:
   ```xml
   <Capabilities>
       <rescap:Capability Name="systemAIModels" />
   </Capabilities>
   ```
6. Add debug identity:
   ```bash
   npx winapp node add-electron-debug-identity
   ```
7. Use the APIs in your main process JavaScript

### Basic Example

```javascript
const {
  LanguageModel,
  AIFeatureReadyResultState,
  TextSummarizer,
  LanguageModelResponseStatus,
} = require("@microsoft/windows-ai-electron");

async function summarizeText() {
  const readyResult = await LanguageModel.EnsureReadyAsync();
  if (readyResult.Status !== AIFeatureReadyResultState.Success) {
    console.log("AI not ready:", readyResult.ErrorDisplayText);
    return;
  }

  const model = await LanguageModel.CreateAsync();
  const textSummarizer = new TextSummarizer(model);
  const result = await textSummarizer.SummarizeAsync("Your long text here...");

  if (result.Status === LanguageModelResponseStatus.Complete) {
    console.log("Summary:", result.Text);
  }
}
```

## Documentation

- [README](README.md) - Full getting started guide and project overview
- [API Reference](docs/API-Reference.md) - Complete list of supported APIs with method signatures
- [Usage Guide](docs/Usage.md) - Detailed usage examples for all features
- [Release Process](docs/Releases.md) - Information about prerelease and stable releases

## External Resources

- [Windows AI APIs Documentation](https://learn.microsoft.com/en-us/windows/ai/apis/)
- [Electron Gallery](https://github.com/microsoft/electron-gallery) - Sample Electron apps using this package
- [AI Dev Gallery](https://github.com/microsoft/ai-dev-Gallery) - Windows AI samples
- [WinAppCli](https://github.com/microsoft/WinAppCli) - Required dependency for Windows API access

## Supported API Namespaces

- [Microsoft.Windows.AI.Text](https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.windows.ai.text?view=windows-app-sdk-1.8)
- [Microsoft.Windows.AI.Imaging](https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.windows.ai.imaging?view=windows-app-sdk-1.8)
- [Microsoft.Windows.AI](https://learn.microsoft.com/en-us/windows/windows-app-sdk/api/winrt/microsoft.windows.ai?view=windows-app-sdk-1.8)

## Repository

- GitHub: https://github.com/microsoft/windows-ai-electron
- Issues: https://github.com/microsoft/windows-ai-electron/issues
- npm: @microsoft/windows-ai-electron

## License

MIT