botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/entityRecognizerSet.ts

Rule system for the Microsoft BotBuilder dialog system.

/**
 * @module botbuilder-dialogs-adaptive
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

import { Entity } from 'botbuilder';
import { DialogContext } from 'botbuilder-dialogs';
import { EntityRecognizer } from './entityRecognizer';
import { TextEntity } from './textEntity';

/**
 * EntityRecognizerSet - Implements a workflow against a pool of [EntityRecognizer](xref:botbuilder-dialogs-adaptive.EntityRecognizer) instances, iterating until nobody has anything new to add.
 */
export class EntityRecognizerSet extends Array<EntityRecognizer> {
    static $kind = 'Microsoft.EntityRecognizerSet';

    /**
     * Implement [EntityRecognizer.recognizeEntities](xref:botbuilder-dialogs-adaptive.EntityRecognizer.recognizeEntities) by iterating against the Recognizer pool.
     *
     * @param dialogContext [DialogContext](xref:botbuilder-dialogs.DialogContext) for the current turn of conversation.
     * @param text Text to recognize.
     * @param locale Locale to use.
     * @param entities The [Entity](xref:botframework-schema.Entity) array to be recognized. If no entities are passed in, it will generate a [TextEntity](xref:botbuilder-dialogs-adaptive.TextEntity).
     * @returns Recognized [Entity](xref:botframework-schema.Entity) list Promise.
     */
    async recognizeEntities(
        dialogContext: DialogContext,
        text: string,
        locale: string,
        entities: Entity[] = []
    ): Promise<Entity[]> {
        const allNewEntities: Entity[] = [];
        let entitiesToProcess: Entity[] = [...entities];

        if (entitiesToProcess.length == 0) {
            const textEntity = new TextEntity(text);
            textEntity['start'] = 0;
            textEntity['end'] = text.length;
            textEntity['score'] = 1.0;
            allNewEntities.push(textEntity);
            entitiesToProcess.push(textEntity);
        }

        do {
            const newEntitiesToProcess: Entity[] = [];
            for (let i = 0; i < this.length; i++) {
                const recognizer: EntityRecognizer = this[i];
                try {
                    const newEntities = await recognizer.recognizeEntities(
                        dialogContext,
                        text,
                        locale,
                        entitiesToProcess
                    );
                    for (let j = 0; j < newEntities.length; j++) {
                        const newEntity = newEntities[j];
                        // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
                        if (
                            !allNewEntities.find(
                                (entity) => !newEntity && JSON.stringify(entity) == JSON.stringify(newEntity)
                            )
                        ) {
                            allNewEntities.push(newEntity);
                            newEntitiesToProcess.push(newEntity);
                        }
                    }
                } catch (e) {
                    console.log(e);
                }
            }

            entitiesToProcess = newEntitiesToProcess;
        } while (entitiesToProcess.length > 0);

        return allNewEntities;
    }
}