Interface AIContextProviderAlpha

A provider that contributes context information to the AI chat.

Components register providers to share relevant state with the AI. When the AI chat needs context, it calls getContext() on all registered providers and collects their contributions.

Typically, providers are registered when a component is created or connected to the DOM, and unregistered when disconnected. Alternatively, some components may register/unregister based on visibility if context should only be provided while the component is visible to the user.

The register() method returns an unregister function for cleanup.

Example

Registering a provider in a Stencil component

@Component({ tag: 'my-custom-panel' })
export class MyCustomPanel {
    @Element()
    private host: HTMLElement & LimeWebComponent;

    private unregisterContext: () => void;

    connectedCallback() {
        const registry = this.platform.get(PlatformServiceName.AIContextRegistry);
        this.unregisterContext = registry.register({
            contextType: 'my-custom-panel',
            getContext: () => ({
                purpose: 'Lets users select items for bulk operations. ' +
                         'Selected items can be exported or bulk-edited.',
                data: {
                    selectedItemIds: this.selectedItems.map(i => i.id),
                    selectionCount: this.selectedItems.length
                }
            })
        }, this.host);
    }

    disconnectedCallback() {
        this.unregisterContext?.();
    }
}