@ckeditor/ckeditor5-ai 41.3.1 → 41.4.0

package/dist/types/adapters/openaitextadapter.d.ts

@@ -0,0 +1,187 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ai/adapters/openaitextadapter
+ * @publicApi
+ */
+import { type Editor } from 'ckeditor5/src/core.js';
+import { default as AITextAdapter, type AITextAdapterRequestData, type RequestHeaders, type RequestParameters } from './aitextadapter.js';
+/**
+ * Adapter for AI text-related requests that supports OpenAI and Azure OpenAI services.
+ *
+ * See also {@link module:ai/adapters/aitextadapter~AITextAdapter}.
+ */
+export default class OpenAITextAdapter extends AITextAdapter {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "OpenAITextAdapter";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * Performs the request to the OpenAI service, Azure OpenAI service, or to the endpoint provided in the editor configuration.
+     *
+     * If you want to extend this adapter, you can overload this method to do some additional processing or make an external call.
+     */
+    sendRequest({ query, context, onData, actionId }: AITextAdapterRequestData): Promise<void>;
+    /**
+     * Prepares the actual request messages to be sent as a part of the request to the AI service.
+     *
+     * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more.
+     *
+     * This method returns two messages, one "system message" with general instructions for the model and one "user message"
+     * with the actual instruction to perform.
+     *
+     * The messages are different, based on whether there is any `context` provided. If no `context` is provided, it is assumed that
+     * the user wants to generate new content. If `context` is provided, it is assumed that the user wants to process this `context`
+     * (e.g. translate) or generate something based on `context` (e.g. summary).
+     *
+     * You can overload this method to customize the messages that are sent to the AI service.
+     *
+     * @param query The user's query. The instruction which the model should perform.
+     * @param context The context for the instruction. Usually this will be a part of the editor content. Can be empty.
+     * @param actionId ID of the performed action. See {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId}.
+     */
+    prepareMessages(query: string, context: string, actionId: string): Promise<Array<RequestMessageItem>>;
+}
+/**
+ * The configuration for the OpenAI adapter.
+ *
+ * The properties defined in this config are set in the `config.ai.openAI` namespace.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		ai: {
+ * 		    openAI: {
+ * 		        requestHeaders: {
+ * 		            Authorization: 'Bearer OPENAI_API_KEY'
+ * 		        }
+ * 		    }
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface OpenAITextAdapterConfig {
+    /**
+     * The URL to which the AI service request will be sent.
+     *
+     * By default, requests are sent to the OpenAI API service. Change this value to make requests to Azure OpenAI API or use proxy endpoint
+     * in your application instead.
+     *
+     * Defaults to `'https://api.openai.com/v1/chat/completions'`.
+     */
+    apiUrl?: string;
+    /**
+     * Object with headers to set in the request to the AI service API.
+     *
+     * If the provided value is an `object`, it is simply used as provided.
+     *
+     * If you are connecting directly to the OpenAI API, use your OpenAI API key in the following way:
+     *
+     * ```js
+     * {
+     * 	ai: {
+     * 		openAI: {
+     * 			requestHeaders: {
+     * 		 		'Authorization': 'Bearer YOUR_API_KEY'
+     * 			}
+     * 			// ...
+     * 		}
+     * 	// ..
+     * 	}
+     * }
+     * ```
+     *
+     * **Important: use your API key ONLY in a development environment or for testing purposes!**
+     * In the production environment, pass your request through a proxy endpoint.
+     *
+     * If you are using a proxy service to send requests to the OpenAI API, `requestHeaders` can be used to implement authorization for your
+     * requests.
+     *
+     * If the provided value is a function, it should be a function that returns a `Promise` which resolves with the headers object.
+     * This way, you can perform an authorization request to your application and receive the authorization token (and also implement
+     * any custom logic on the back-end side). The headers object is then used to make the actual call to the AI service.
+     *
+     * The function is passed {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} parameter to make it
+     * possible to further customize the headers.
+     *
+     * ```js
+     * {
+     * 	ai: {
+     * 		openAI: {
+     * 			requestHeaders: async () => {
+     * 				const jwt = await fetch( 'https://example.com/jwt-endpoint' );
+     *
+     * 				return {
+     * 					'Authorization': 'Bearer ' + jwt
+     * 				};
+     * 			}
+     * 			// ...
+     * 		}
+     * 	}
+     * }
+     * ```
+     *
+     * If the function fails for any reason, the promise should be rejected. In this case, a feature that made the request should display
+     * an error notification.
+     */
+    requestHeaders?: RequestHeaders;
+    /**
+     * Additional configuration parameters for the AI service request. Use it to customize how the AI service generates responses.
+     * Note that the value you will set here will fully overwrite the default value.
+     *
+     * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more about available parameters.
+     *
+     * If the provided value is an `object`, it is passed to the request as provided.
+     *
+     * If the provided value is a function, it should be a function that returns a `Promise` which resolves with the request parameters
+     * object. This gives you more flexibility to provide parameters for the AI model.
+     *
+     * The function is passed {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} parameter to make it
+     * possible to further customize the parameters.
+     *
+     * If the function fails for any reason, the promise should be rejected. In this case, the feature that made the request should display
+     * an error notification.
+     *
+     * Defaults to:
+     *
+     * ```json
+     * {
+     * 	model: 'gpt-3.5-turbo',
+     * 	max_tokens: 2000,
+     * 	temperature: 1,
+     * 	top_p: 1,
+     * 	stream: true
+     * }
+     * ```
+     */
+    requestParameters?: RequestParameters;
+}
+/**
+ * Single message item, in the format required for the OpenAI request.
+ *
+ * Example:
+ *
+ * ```json
+ * { role: 'system', content: 'You are a helpful assistant.' }
+ * ```
+ *
+ * See [OpenAI API reference](https://platform.openai.com/docs/api-reference/chat/create) to learn more.
+ */
+type RequestMessageItem = Record<string, string>;
+export {};

package/dist/types/aiassistant.d.ts

@@ -0,0 +1,390 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ai/aiassistant
+ * @publicApi
+ */
+import { type Locale } from 'ckeditor5/src/utils.js';
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import AIAssistantUI from './aiassistantui.js';
+import AIAssistantEditing from './aiassistantediting.js';
+/**
+ * AI assistant plugin that allows you to use external AI models to generate content or improve existing content.
+ *
+ * The feature uses following {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} values:
+ *
+ * * `aiAssistant:command:<commandId>` for the predefined commands, where `<commandId>` is the ID of the predefined command,
+ * * `aiAssistant:custom` for custom queries provided by the user.
+ */
+export default class AIAssistant extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof AIAssistantUI, typeof AIAssistantEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AIAssistant";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+}
+/**
+ * A function that returns the list of the default AI commands definitions in the given localization context.
+ */
+export declare function getDefaultCommands(locale: Locale): Array<GroupDefinition>;
+/**
+ * The configuration of the AI Assistant feature.
+ *
+ * The properties defined in this config are set in the `config.ai.aiAssistant` namespace.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( editorElement, {
+ * 		ai: {
+ * 		    aiAssistant: {
+ * 		        // AI Assistant configuration.
+ * 		    }
+ * 		}
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface AIAssistantConfig {
+    /**
+     * A list of all AI commands groups definitions to be displayed in the `'aiCommands'` UI dropdown.
+     *
+     * Setting this property will overwrite the default list of predefined commands.
+     *
+     * The default configuration is as follows. It can be obtained through {@link ~getDefaultCommands}:
+     *
+     * ```json
+     * [ {
+     * 	groupId: 'editOrReview',
+     * 	groupLabel: 'Edit or review',
+     * 	commands: [
+     * 		{
+     * 			id: 'improveWriting',
+     * 			label: 'Improve writing',
+     * 			prompt: 'Fix spelling mistakes, use proper grammar and apply good writing practices. Do not lose the original meaning.'
+     * 		},
+     * 		{
+     * 			id: 'makeShorter',
+     * 			label: 'Make shorter',
+     * 			prompt: 'Remove any repetitive, redundant, or non-essential writing in this content ' +
+     * 				'without changing the meaning or losing any key information.'
+     * 		},
+     * 		{
+     * 			id: 'makeLonger',
+     * 			label: 'Make longer',
+     * 			prompt: 'Improve this content by using descriptive language and inserting more information and more detailed explanations.'
+     * 		},
+     * 		{
+     * 			id: 'simplifyLanguage',
+     * 			label: 'Simplify language',
+     * 			prompt: 'Simplify the writing style of this content ' +
+     * 				'and reduce the complexity, so that the content is easy to understand.'
+     * 		}
+     * 	]
+     * },
+     * {
+     * 	groupId: 'generate',
+     * 	groupLabel: 'Generate from selection',
+     * 	commands: [
+     * 		{
+     * 			id: 'summarize',
+     * 			label: 'Summarize',
+     * 			prompt: 'Summarize this content into one paragraph of text. Include only the key ideas and conclusions. Keep it short. '
+     * 		},
+     * 		{
+     * 			id: 'continue',
+     * 			label: 'Continue',
+     * 			prompt: 'Start with the provided content and write at the end of it continuing this topic. Keep the added part short.'
+     * 		}
+     * 	]
+     * },
+     * {
+     * 	groupId: 'changeTone',
+     * 	groupLabel: 'Change tone',
+     * 	commands: [
+     * 		{
+     * 			id: 'professional',
+     * 			label: 'Professional',
+     * 			prompt: 'Improve using polished, formal, and respectful language ' +
+     * 				'to convey professional expertise and competence.'
+     * 		},
+     * 		{
+     * 			id: 'casual',
+     * 			label: 'Casual',
+     * 			prompt: 'Improve using casual, informal language to convey a casual conversation with a real person.'
+     * 		},
+     * 		{
+     * 			id: 'direct',
+     * 			label: 'Direct',
+     * 			prompt: 'Improve using direct language using only the essential information.'
+     * 		},
+     * 		{
+     * 			id: 'confident',
+     * 			label: 'Confident',
+     * 			prompt: 'Improve using compelling, optimistic language to convey confidence in the writing.'
+     * 		},
+     * 		{
+     * 			id: 'friendly',
+     * 			label: 'Friendly',
+     * 			prompt: 'Improve using friendly, comforting language, to convey understanding and empathy.'
+     * 		}
+     * 	]
+     * },
+     * {
+     * 	groupId: 'changeStyle',
+     * 	groupLabel: 'Change style',
+     * 	commands: [
+     * 		{
+     * 			id: 'business',
+     * 			label: 'Business',
+     * 			prompt: 'Rewrite this content as a business professional with formal language.'
+     * 		},
+     * 		{
+     * 			id: 'legal',
+     * 			label: 'Legal',
+     * 			prompt: 'Rewrite this content as a legal professional using valid legal terminology.'
+     * 		},
+     * 		{
+     * 			id: 'journalism',
+     * 			label: 'Journalism',
+     * 			prompt: 'Rewrite this content as a journalist using engaging language to convey the importance of the information.'
+     * 		},
+     * 		{
+     * 			id: 'poetic',
+     * 			label: 'Poetic',
+     * 			prompt: 'Rewrite this content as a poem using poetic techniques without losing the original meaning.'
+     * 		}
+     * 	]
+     * },
+     * {
+     * 	groupId: 'translate',
+     * 	groupLabel: 'Translate',
+     * 	commands: [
+     * 		{
+     * 			id: 'translateEnglish',
+     * 			label: 'Translate to English',
+     * 			prompt: 'Translate the content to English language.'
+     * 		},
+     * 		{
+     * 			id: 'translateSpanish',
+     * 			label: 'Translate to Spanish',
+     * 			prompt: 'Translate the content to Spanish language.'
+     * 		},
+     * 		{
+     * 			id: 'translatePortuguese',
+     * 			label: 'Translate to Portuguese',
+     * 			prompt: 'Translate the content to Portuguese language.'
+     * 		},
+     * 		{
+     * 			id: 'translateGerman',
+     * 			label: 'Translate to German',
+     * 			prompt: 'Translate the content to German language.'
+     * 		},
+     * 		{
+     * 			id: 'translateFrench',
+     * 			label: 'Translate to French',
+     * 			prompt: 'Translate the content to French language.'
+     * 		},
+     * 		{
+     * 			id: 'translateChinese',
+     * 			label: 'Translate to Simplified Chinese',
+     * 			prompt: 'Translate the content to Simplified Chinese language.'
+     * 		},
+     * 		{
+     * 			id: 'translateHindi',
+     * 			label: 'Translate to Hindi',
+     * 			prompt: 'Translate the content to Hindi language.'
+     * 		},
+     * 		{
+     * 			id: 'translateArabic',
+     * 			label: 'Translate to Arabic',
+     * 			prompt: 'Translate the content to Arabic language.'
+     * 		}
+     * 	]
+     * } ]
+     * ```
+     */
+    commands?: Array<GroupDefinition>;
+    /**
+     * A list of additional AI commands groups definitions that will extend
+     * {@link module:ai/aiassistant~AIAssistantConfig#commands default commands}.
+     *
+     * You can define new AI commands groups or add new AI commands to existing groups. If you add AI commands to an existing group,
+     * you do not need to specify `groupLabel` property. Use the (optional) `order` property to control the position of new groups
+     * and commands.
+     *
+     * An example configuration:
+     *
+     * ```json
+     * {
+     * 	aiAssistant: {
+     * 		extraCommandGroups: [
+     * 			// Add an AI command to an existing group:
+     * 			{
+     *				groupId: 'changeTone',
+     *				commands: [
+     *					{
+     *						id: 'sad',
+     *						label: 'Sad',
+     *						prompt: 'Rewrite this text to make it sound sad and depressing.',
+     *						// You can specify the position of this command among existing ones. Commands use zero-based numbering.
+     *						order: 2
+     *					}
+     *				]
+     * 			},
+     * 			// Create a new AI commands group:
+     * 			{
+     * 				groupId: 'transformations',
+     * 				groupLabel: 'Transformations',
+     *				// You can specify the position of this group among existing ones. Groups use zero-based numbering.
+     * 				order: 3,
+     * 				commands: [
+     * 					{
+     * 						id: 'addEmojis',
+     * 						label: 'Add emojis',
+     * 						prompt: 'Analyze each sentence of this text. After each sentence add an emoji that summarizes the sentence.'
+     * 					},
+     * 					// ...
+     * 				]
+     * 			},
+     * 		],
+     * 		// ...
+     * 	}
+     * }
+     * ```
+     */
+    extraCommandGroups?: Array<GroupDefinition>;
+    /**
+     * A list of ids of AI commands to be removed.
+     *
+     * Learn more about {@link module:ai/aiassistant~CommandDefinition command definition and its id}.
+     *
+     * An example configuration:
+     *
+     * ```json
+     * {
+     * 	aiAssistant: {
+     * 		removeCommands: [
+     * 			'improveWriting',
+     * 			// ...
+     * 		],
+     * 		// ...
+     * 	}
+     * }
+     * ```
+     */
+    removeCommands?: Array<string>;
+    /**
+     * An additional CSS class name (or names) added to the AI assistant content area (model response area).
+     *
+     * Because the content area is usually detached from the flow of the document, this configuration
+     * allows for better integration with application's stylesheets and improves the consistency of content
+     * styles.
+     */
+    contentAreaCssClass?: string;
+    /**
+     * The AI assistant feature will be disabled if the document selection includes any of these elements.
+     *
+     * Use this property if AI assistant does not work properly with your custom features.
+     *
+     * Currently, by default, AI assistant is disabled for following model elements:
+     *
+     * * Media embed (`'media'`) -- does not display in response area,
+     * * HTML embed (`'rawHtml'`) -- sometimes does not display in response area, security uncertainty,
+     * * Table of contents (`'tableOfContents'`) -- does not display properly in response area, long processing time.
+     *
+     * You can set this list to include more model elements or clear it to enable the above features.
+     *
+     * Note, that all or some of these features may become enabled in the future.
+     *
+     * @default [ 'media', 'rawHtml', 'tableOfContents' ]
+     */
+    disabledElements?: Array<string>;
+}
+export type GroupDefinition = {
+    /**
+     * The unique identifier of the group. It can be referenced while extending existing groups
+     * using {@link module:ai/aiassistant~AIAssistantConfig#extraCommandGroups}.
+     */
+    groupId: string;
+    /**
+     * The human-readable label of the group.
+     */
+    groupLabel?: string;
+    /**
+     * The array of command definitions that belong to the group.
+     */
+    commands: Array<CommandDefinition>;
+    /**
+     * The order of the group on the list. The lower the number, the higher the group is displayed on the list.
+     * If not specified, the position of this group will be determined by the order of
+     * {@link module:ai/aiassistant~AIAssistantConfig#commands configuration}.
+     *
+     * If a new group is added without `order` property, it will be added at the end.
+     *
+     * The order uses zero-based numbering (the first group's order is `0`).
+     */
+    order?: number;
+};
+export type CommandDefinition = {
+    /**
+     * The unique identifier of the command. It can be referenced while removing commands. See
+     * {@link module:ai/aiassistant~AIAssistantConfig#removeCommands} to learn more.
+     */
+    id: string;
+    /**
+     * The human-readable label of the command.
+     */
+    label: string;
+    /**
+     * The instruction that will be passed to the AI model.
+     *
+     * It is wrapped in a "full prompt template" for better results.
+     */
+    prompt: string;
+    /**
+     * By default, all commands require a selection for the assistant to work on. If the selection is collapsed,
+     * it automatically expands to the nearest block boundaries to provide the AI context.
+     *
+     * Setting this to `false` allows the command to work on a collapsed selection and prevent selection expansion.
+     * This is helpful, for instance, for commands that generate content from scratch.
+     *
+     * **Note**: If not specified, the default is `true`.
+     */
+    requiresContent?: boolean;
+    /**
+     * The order of the command on the list. The lower the number, the higher the command is displayed on the list.
+     * If not specified, the position of this command will be determined by the order of
+     * {@link module:ai/aiassistant~AIAssistantConfig#commands configuration}.
+     *
+     * If a new command is added without `order` property, it will be added at the end of the group.
+     *
+     * The order uses zero-based numbering (the first command's order is `0`).
+     */
+    order?: number;
+};

package/dist/types/aiassistantediting.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ai/aiassistantediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import type { Position } from 'ckeditor5/src/engine.js';
+/**
+ * The AI assistant editing plugin.
+ */
+export default class AIAssistantEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AIAssistantEditing";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Displays a fake visual selection.
+     *
+     * This adds a 'ai-ui-candidate' (for the commands dropdown) or 'ai-ui' (for the assistant dialog)
+     * marker into the document that is rendered as a highlight on selected text fragment.
+     */
+    showFakeVisualSelection(isCandidate?: boolean): void;
+    /**
+     * Removes a fake visual selection.
+     *
+     * This clears a 'ai-ui-candidate' (for the commands dropdown) or 'ai-ui' (for the assistant dialog)
+     * marker from the document.
+     */
+    hideFakeVisualSelection(isCandidate?: boolean): void;
+    /**
+     * Converts the HTML string into the model fragment and inserts it at the specified position.
+     *
+     * If a position is not provided, the insertion will replace the visual selection marker.
+     */
+    insertContent(content: string, position?: Position): void;
+    /**
+     * Converts the HTML string into the model fragment and inserts it below the visual selection marker.
+     */
+    insertContentBelow(content: string): void;
+}

package/dist/types/aiassistantui.d.ts

@@ -0,0 +1,57 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module ai/aiassistantui
+ * @publicApi
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Dialog } from 'ckeditor5/src/ui.js';
+import AIAssistantEditing from './aiassistantediting.js';
+import AIAdapter from './adapters/aiadapter.js';
+import '../theme/ai.css';
+import '../theme/ai-dropdown.css';
+import '../theme/ai-form.css';
+import { ClipboardMarkersUtils } from 'ckeditor5/src/clipboard.js';
+/**
+ * The UI plugin of the AI assistant.
+ */
+export default class AIAssistantUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "AIAssistantUI";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof AIAssistantEditing, typeof AIAdapter, typeof Dialog];
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+    /**
+     * Initializes the AI Assistant main view and displays it in a dialog, based on the selection. Also, shows fake selection marker.
+     *
+     * @param query The initial query. If set, the AI assistant will automatically submit given query to the AI service.
+     * @param label Label to be displayed in the AI assistant query input field while the AI assistant processes the initial query.
+     * @param actionId The id of the executed action. It can be used in extended and custom adapters to customize the request.
+     */
+    showUI(query?: string, label?: string, actionId?: string): void;
+    /**
+     * Hides the AI dialog.
+     */
+    hideUI(): void;
+}