@ckeditor/ckeditor5-ai 44.1.0-alpha.5 → 44.2.0-alpha.0

package/dist/adapters/aitextadapter.d.ts

@@ -1,150 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module ai/adapters/aitextadapter
- * @publicApi
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import { default as AIAdapter } from './aiadapter.js';
-/**
- * Abstract base class for AI adapters that perform text-related requests.
- *
- * Concrete AI text adapter implementation plugin, after loaded by the editor, will set itself as
- * {@link module:ai/adapters/aiadapter~AIAdapter#textAdapter `AIAdapter#textAdapter`}.
- *
- * Then, features making text-related AI requests will use that concrete adapter through
- * {@link module:ai/adapters/aitextadapter~AITextAdapter#makeRequest `AIAdapter#textAdapter#makeRequest()`}.
- *
- * You can create your own adapter that may connect to any model by extending this abstract class.
- */
-export default abstract class AITextAdapter extends Plugin {
-    /**
-     * Abort controller instance.
-     *
-     * It is used by {@link ~AITextAdapter#abort `abort()`}.
-     *
-     * It should be passed to the mechanism that performs the request (e.g. `fetch()`).
-     */
-    abortController: AbortController;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof AIAdapter];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * The method that stops the current request and then recreates the abort controller instance.
-     *
-     * It should be called when the currently processed request should be aborted (e.g. when the user closes the UI as the request is
-     * processed).
-     */
-    abort(): void;
-    /**
-     * Makes the AI request to the AI API service and processes the response from the service.
-     *
-     * Internally, it uses {@link ~AITextAdapter#sendRequest `sendRequest()`}.
-     *
-     * If you are creating a custom adapter, implement `sendRequest()` rather than extending this method.
-     *
-     * Implements basic error handling for errors thrown by `sendRequest()`:
-     *
-     * * {@link module:ai/adapters/aiadapter~AIRequestError `AIRequestError`} is re-thrown, and it is expected to be handled by the feature
-     * that made the request (e.g. by displaying some error notification).
-     * * {@link module:utils/ckeditorerror~CKEditorError `CKEditorError`} is unexpected, is logged to the console, and re-thrown.
-     * * `'AbortError'` is expected and is silenced. It is thrown when the request is aborted and does not need to be handled.
-     *
-     * @returns A Promise that resolves with the AI-generated response.
-     */
-    makeRequest(requestData: AITextAdapterRequestData): Promise<void>;
-    /**
-     * Abstract method.
-     *
-     * Creates the request using provided `requestData`. Makes the request to the AI service endpoint. Handles the AI service response.
-     *
-     * If you want to extend an existing adapter, you can overload this method to do some additional processing or make an external call.
-     *
-     * If you want to create a custom adapter, the main logic related to making and handling the request should be implemented here.
-     * Make sure to properly implement {@link ~AITextAdapterRequestData#onData `onData()`} callback handling.
-     */
-    abstract sendRequest(requestData: AITextAdapterRequestData): Promise<void>;
-}
-export type AITextAdapterRequestData = {
-    /**
-     * The user's query.
-     */
-    query: string;
-    /**
-     * The context on which the query is used.
-     *
-     * May be empty. In such case, it is assumed that the user wanted to create new textual content.
-     */
-    context: string;
-    /**
-     * A callback that is called whenever the data received by the adapter is updated.
-     *
-     * If the adapter does not use streaming, and receives the whole answer at once, it should call `onData()` once, when the data is
-     * received.
-     *
-     * If the adapter uses streaming, the adapter should internally build the whole received data and fire `onData()` callback with the
-     * full update data each time. For example, if during streaming, the adapter receives following chunks: `'<p>T'`, `'his is an'`, and
-     * `' example</p>'`, then it should fire `onData()` with: `'<p>T'`, `'<p>This is an'`, and `'<p>This is an example</p>'`.
-     */
-    onData: AITextAdapterDataCallback;
-    /**
-     * ID of the performed action. This is a unique ID for each feature and each action that triggers the AI request.
-     *
-     * The main role for `actionId` is to distinguish which feature made the call. The action ID can be used in extended and custom adapters
-     * to customize the request.
-     *
-     * Each AI feature describes what action IDs it creates and uses. For example, the AI Assistant feature uses `actionId` values like
-     * `'aiAssistant:custom'`, or `'aiAssistant:command:improveWriting'`.
-     */
-    actionId: string;
-};
-/**
- * Object with headers to set in the request to the AI service.
- *
- * If the provided value is an `object`, it is simply used as provided.
- *
- * 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.
- *
- * 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.
- */
-export type RequestHeaders = Record<string, string> | ((actionId: string) => Promise<Record<string, string>>);
-/**
- * Additional configuration parameters for the AI request. Use it to customize how the AI service generates responses.
- *
- * See the reference for the AI service of your choice to learn what parameters can be used with that service or model.
- *
- * 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.
- */
-export type RequestParameters = Record<string, any> | ((actionId: string) => Promise<Record<string, any>>);
-/**
- * Callback called each time the AI text adapter receives data.
- *
- * @params content The received data.
- */
-export type AITextAdapterDataCallback = (content: string) => any;

package/dist/adapters/awstextadapter.d.ts

@@ -1,183 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @module ai/adapters/awstextadapter
- * @publicApi
- */
-import { type Editor } from 'ckeditor5/src/core.js';
-import { default as AITextAdapter, type AITextAdapterRequestData, type RequestHeaders, type RequestParameters } from './aitextadapter.js';
-import { type BedrockRuntimeClientConfig } from '@aws-sdk/client-bedrock-runtime';
-/**
- * Adapter for AI text-related requests that supports the Amazon Bedrock service.
- *
- * See also {@link module:ai/adapters/aitextadapter~AITextAdapter}.
- */
-export default class AWSTextAdapter extends AITextAdapter {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "AWSTextAdapter";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * Performs the request to the Amazon Bedrock 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 full prompt for the request to the Amazon Bedrock API.
-     *
-     * The prompt may differ depending on what model is used.
-     *
-     * You can overload this method to customize the prompts 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 model Model that is used to perform the request.
-     * @param actionId ID of the performed action. See {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId}.
-     */
-    preparePrompt(query: string, context: string, model: string, actionId: string): Promise<string>;
-    /**
-     * For a given model, it returns the family to which this model belongs.
-     *
-     * For example, for `anthropic.claude-instant-v1` it will return `anthropic.claude`.
-     *
-     * Throws {@link module:ai/adapters/aiadapter~AIRequestError `AIRequestError`} if a given model is not supported.
-     */
-    getModelFamily(model: string): AWSModelFamily;
-}
-/**
- * The configuration for the Amazon Bedrock adapter.
- *
- * The properties defined in this configuration are set in the `config.ai.aws` namespace.
- *
- * ```ts
- * ClassicEditor
- * 	.create( editorElement, {
- * 		ai: {
- * 		    aws: {
- * 		        apiUrl: 'https://url.to.your.application/ai'
- * 		    }
- * 		}
- * 	} )
- * 	.then( ... )
- * 	.catch( ... );
- * ```
- *
- * See {@link module:ai/aiconfig~AIConfig the full AI configuration}.
- *
- * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
- */
-export interface AWSTextAdapterConfig {
-    /**
-     * The URL to which the AI service request will be sent.
-     *
-     * Set this value only if you want to connect to Amazon Bedrock using a proxy endpoint.
-     *
-     * If `apiUrl` is not provided, the AWS-SDK library will be used to process the request. It will set a proper URL on its own.
-     */
-    apiUrl?: string;
-    /**
-     * An object with headers to set in the request to the AI service.
-     *
-     * **These headers are only used when connecting to AWS through the proxy endpoint (that is, when `apiUrl` is set).**
-     *
-     * Otherwise, the AWS-SDK library is used, and it sets the request headers on its own. In this mode, the request headers cannot be
-     * customized.
-     *
-     * If the provided value is an object, it is simply used as provided.
-     *
-     * ```js
-     * {
-     * 	ai: {
-     * 		aws: {
-     * 			requestHeaders: {
-     * 		 		'Authorization': 'Bearer YOUR_API_KEY'
-     * 			}
-     * 		}
-     * 		// ...
-     * 	}
-     * }
-     * ```
-     *
-     * 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 backend side). The headers object is then used to make the actual call to the AI service.
-     *
-     * ```js
-     * {
-     * 	ai: {
-     * 		aws: {
-     * 			requestHeaders: async () => {
-     * 				const jwt = await fetch( 'https://example.com/jwt-endpoint' );
-     *
-     * 				return {
-     * 					'Authorization': 'Bearer ' + jwt
-     * 				}
-     * 			}
-     * 		}
-     * 		// ...
-     * 	}
-     * }
-     * ```
-     *
-     * The function is passed the {@link module:ai/adapters/aitextadapter~AITextAdapterRequestData#actionId `actionId`} parameter to make it
-     * possible to further customize the headers.
-     *
-     * 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.
-     *
-     * The exact configuration (available parameters) depends on the used model. Keep in mind that some properties are not supported by some
-     * models.
-     *
-     * See [AWS model parameters reference](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html) to learn more.
-     *
-     * 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 the {@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: 'anthropic.claude-v2',
-     * 	max_tokens_to_sample: 500,
-     * 	temperature: 1,
-     * 	top_k: 250,
-     * 	top_p: 1,
-     * 	anthropic_version: 'bedrock-2023-05-31',
-     * 	stream: true
-     * }
-     * ```
-     */
-    requestParameters?: RequestParameters;
-    /**
-     * The configuration for AWS-SDK Bedrock Runtime Client.
-     *
-     * If `apiUrl` is not provided, this configuration will be used to initialize the Bedrock Runtime Client which will be used to process
-     * the requests. The adapter will make requests directly to the Amazon Bedrock service.
-     */
-    bedrockClientConfig?: BedrockRuntimeClientConfig;
-}
-export type AWSModelFamily = 'anthropic.claude' | 'ai21.j2' | 'cohere.command' | 'meta.llama';

package/dist/adapters/openaitextadapter.d.ts

@@ -1,187 +0,0 @@
-/**
- * @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-licensing-options
- */
-/**
- * @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 {};