Socket
Socket
Sign inDemoInstall

@botbuildercommunity/middleware-text-analytics

Package Overview
Dependencies
4
Maintainers
4
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@botbuildercommunity/middleware-text-analytics

Bot Framework middleware component for the Cognitive Services Text Analytics API, including sentiment analysis, language detection, entity extraction, and keyword recognition.


Version published
Maintainers
4
0

Weekly downloads

Readme

Source

Text Analytics Middleware

The Text Analytics Middleware offers Bot Framework middleware components for the Cognitive Services Text Analytics API. You will need an Azure account, as well as a Cognitive Services resource created on Azure. Take a look at the Microsoft Text Analytics API documentation for details.

Installing

npm install @botbuildercommunity/middleware-text-analytics --save

Usage

All middleware is created and used in the same way. For example, for sentiment analysis, import the SentimentAnalysis class from the package, and add it to your bot adapter:

import { SentimentAnalysis } from '@botbuildercommunity/middleware-text-analytics';

adapter.use(new SentimentAnalysis(YOUR_TEXT_ANALYTICS_KEY, TEXT_ANALYTICS_API_ENDPOINT, SERVICE_CLIENT_OPTIONS));

The CLIENT_OPTIONS parameter is optional.

Note that the TEXT_ANALYTICS_API_ENDPOINT will be the Cognitive Services endpoint root. For example: https://eastus.api.cognitive.microsoft.com

When used, the turnState on the TurnContext will have a property named sentimentScore between 0 and 1. A full example can be seen in the sample bot test file.

Supported middleware classes include:

  • SentimentAnalysis
  • LanguageDetection
  • KeyPhrases
  • EntityExtraction

Each class takes the two required parameters in the example usage above (with the SERVICE_CLIENT_OPTIONS parameter being optional).

In each case, properties are added to the turnState of the TurnContext. You can retrieve them in your bot via:

  • context.turnState.get('sentimentScore') //This is a number for SentimentAnalysis
  • context.turnState.get('language') //This is a string for LanguageDetection
  • context.turnState.get('keyPhrases') //This is an array of strings for KeyPhrases
  • context.turnState.get('textEntities') //This is an array of EntityRecord typesforEntityExtraction`

Keywords

FAQs

Last updated on 26 Mar 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc