chrome-llm-ts
v0.2.0
Published
AI Types and Interface library for interacting with in Chrome local language models and streaming responses.
Downloads
134
Maintainers
Readme
chrome-llm-ts
To use this library in your code, follow these steps:
Install the Library (if it's published to npm):
npm install chrome-llm-ts
Set Up Type Declarations for Global Usage: Since you're accessing
window.ai.languageModel
directly, you need to make TypeScript aware of the types for theai
object onwindow
. This involves adding a global augmentation.Create a Declaration File for Global Scope:
In your project (not the library), create a TypeScript declaration file, e.g.,
global.d.ts
, to declare theWindow
interface and itsai
property.// global.d.ts import type { AI } from 'chrome-llm-ts'; declare global { interface Window { ai: AI; } }
Ensure TypeScript picks up this file by adding it to
tsconfig.json
underinclude
:{ "compilerOptions": { "strict": true, "module": "commonjs", "target": "es6" }, "include": ["src", "global.d.ts"] }
Use the Library in Your Code:
After setting up the types, you can directly use
window.ai.languageModel
as follows:// main.ts import 'chrome-llm-ts'; // Import to ensure all types and side effects are available async function initialize() { if (window.ai) { const languageModel = await window.ai.languageModel.create(); const response = await languageModel.prompt("Hello AI!"); console.log("AI Response:", response); } else { console.error("AI SDK is not available on window.ai."); } } initialize();
Summary
- Define
window.ai
as a global property using aglobal.d.ts
file. - Import
chrome-llm-ts
in your main file to ensure all types and interfaces are available. - Access
window.ai.languageModel
directly with TypeScript autocompletion and type safety.