@ckeditor/ckeditor5-ai
Version:
AI features for CKEditor 5.
64 lines (63 loc) • 2.03 kB
TypeScript
/**
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
export declare const CAPABILITIES_MODEL_EVENT_NAMES: readonly ["capabilitiesUpdated"];
declare const AICapabilities_base: {
new (): import("@ckeditor/ckeditor5-utils").Emitter;
prototype: import("@ckeditor/ckeditor5-utils").Emitter;
};
/**
* Manages the AI capabilities configuration and state.
*/
export declare class AICapabilities extends /* #__PURE__ */ AICapabilities_base {
constructor();
/**
* Initializes the capabilities.
*/
init(): void;
/**
* Resets the capabilities configuration to default state.
*/
reset(): void;
/**
* Returns the current capabilities configuration.
*
* @returns The current capabilities configuration.
*/
getCapabilitiesConfig(): AICapabilitiesConfig;
/**
* Converts capabilities configuration to request data format for API endpoint.
* @returns The request data or undefined if no capabilities are enabled.
*/
static getCapabilitiesRequestData(config: AICapabilitiesConfig | undefined): AICapabilitiesRequestData;
/**
* Toggles the web search enabled state.
*/
toggleWebSearch(): void;
/**
* Toggles the reasoning enabled state.
*/
toggleReasoning(): void;
/**
* Sets the web search enabled state and fires an event with current state.
*/
setWebSearch(isWebSearchEnabled: boolean): void;
/**
* Sets the reasoning enabled state and fires an event with current state.
*/
setReasoning(isReasoningEnabled: boolean): void;
}
export type AICapabilitiesUpdatedEvent = {
name: 'capabilitiesUpdated';
args: [AICapabilitiesConfig];
};
export type AICapabilitiesConfig = {
isWebSearchEnabled: boolean;
isReasoningEnabled: boolean;
};
export type AICapabilitiesRequestData = {
webSearch?: object;
reasoning?: object;
};
export {};