botbuilder-dialogs-adaptive/src/recognizers/entityRecognizers/phoneNumberEntityRecognizer.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 { recognizePhoneNumber } from '@microsoft/recognizers-text-sequence';
import { ModelResult } from 'botbuilder-dialogs';
import { TextEntityRecognizer } from './textEntityRecognizer';

/**
 * Recognizes phone number input.
 */
export class PhoneNumberEntityRecognizer extends TextEntityRecognizer {
    static $kind = 'Microsoft.PhoneNumberEntityRecognizer';

    /**
     * @protected
     * Phone number recognizing implementation.
     * @param text Text to recognize.
     * @param culture Culture to use.
     * @returns The recognized [ModelResult](xref:botbuilder-dialogs.ModelResult) list.
     */
    protected _recognize(text: string, culture: string): ModelResult[] {
        return recognizePhoneNumber(text, culture);
    }
}