MAQTextAnalytics (Non-Microsoft Publisher) (#1504)

* Added custom connector files for MAQTextAnalytics

* Updated brand color

* Update apiDefinition.swagger.json
This commit is contained in:
akashdabhi03 2022-05-05 05:59:51 +05:30 коммит произвёл GitHub
Родитель be3d8f9913
Коммит 83d22dba28
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
3 изменённых файлов: 291 добавлений и 0 удалений

Просмотреть файл

@ -0,0 +1,18 @@
# MAQ Text Analytics Connector
MAQ Text Analytics uses Natural Language Processing (NLP) algorithms to mine text data and surface hidden insights. This connector supports Sentiment Analysis, Key Phrase Extraction and PII Scrubbing functionalities which are exposed as operations in Microsoft Power Automate and Power Apps.
# Pre-requisites
You will need the following to proceed:
- A Microsoft Power Apps or Microsoft Power Automate plan with custom connector feature
- Generate an __API Key__ by using the _Get Free Trial_ button in the Developer Zone section on [MAQ Text Analytics](https://maqtextanalytics.azurewebsites.net/#/DevelopersZone).
# Deploying the connector
```
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
```
# Supported Operations
The connector supports the following operations:
- `Sentiment Classifier`: Performs Sentiment Analysis of your text data. Returns sentiment score between 0 and 1 for each document. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment
- `PII Scrubber`: Scrubs Personally Identifiable Information (PII) data from your text based on configured entities. Returns text devoid of PII data
- `Key Phrase Extractor`: Extracts Key Phrases from your text data. Returns a comma separated list of Key Phrases for each document

Просмотреть файл

@ -0,0 +1,250 @@
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Text Analytics",
"description": "Discover meaningful insights in your text data. Perform Sentiment Analysis, extract Key Phrases and scrub PII Data from your text data.",
"contact": {
"name": "MAQ Software Sales",
"url": "https://maqsoftware.com/contact",
"email": "Sales@MAQSoftware.com"
}
},
"host": "maqtextnalyticssdk.azure-api.net",
"basePath": "/",
"schemes": [
"https"
],
"consumes": [],
"produces": [
"application/json"
],
"paths": {
"/text/SentimentClassifier": {
"post": {
"summary": "Sentiment Classifier",
"description": "Perform Sentiment Analysis of your text data",
"operationId": "SentimentClassifier",
"parameters": [
{
"name": "body",
"in": "body",
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "id"
},
"text": {
"type": "string",
"description": "text"
}
}
},
"description": "data"
}
},
"default": {
"data": [
{
"id": 5,
"text": "store wont launch but its coo when it worked"
},
{
"id": 1,
"text": "the best product"
},
{
"id": 2,
"text": "Very easy to understand and use the design lab!"
},
{
"id": 3,
"text": "Due to the COVID 19 pandemic I would not recommend a visit to any store at this time. My order was place on line for an item I have used before and knew exactly was I was looking for. Otherwise, I would recommend a visit to the store after the pandemic passes in order to see whatever product is too be purchased."
},
{
"id": 4,
"text": "quality products, and the warranty service has been outstanding"
},
{
"id": 5,
"text": "store wont launch but its coo when it worked"
}
]
}
},
"required": true
}
],
"responses": {
"200": {
"description": "200",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "id"
},
"sentiment": {
"type": "number",
"format": "float",
"description": "sentiment"
}
}
}
}
}
}
}
},
"/text/PIIScrubber": {
"post": {
"responses": {
"200": {
"description": "200",
"schema": {
"type": "object",
"properties": {
"scrubbed_text": {
"type": "string",
"description": "scrubbed_text"
}
}
}
}
},
"operationId": "PIIScrubber",
"summary": "Scrub PII Data",
"parameters": [
{
"name": "body",
"in": "body",
"required": false,
"schema": {
"type": "object",
"properties": {
"data": {
"type": "string",
"description": "data"
},
"entity_list": {
"type": "string",
"description": "entity_list"
}
}
}
}
],
"description": "Scrub PII data from your text based on configured entities"
}
},
"/text/KeyPhrase": {
"post": {
"responses": {
"200": {
"description": "200",
"schema": {
"type": "array",
"items": {
"type": "object",
"properties": {
"KeyPhrase": {
"type": "string",
"description": "KeyPhrase"
},
"Score": {
"type": "number",
"format": "float",
"description": "Score"
},
"Similar": {
"type": "array",
"items": {
"type": "string"
},
"description": "Similar"
}
}
}
}
}
},
"summary": "Key Phrase Extractor",
"operationId": "KeyPhraseExtractor",
"parameters": [
{
"name": "body",
"in": "body",
"required": false,
"schema": {
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "text"
},
"keyphrases_count": {
"type": "integer",
"format": "int32",
"description": "keyphrases_count"
},
"diversity_threshold": {
"type": "number",
"format": "float",
"description": "diversity_threshold"
},
"alias_threshold": {
"type": "number",
"format": "float",
"description": "alias_threshold"
}
}
}
}
],
"description": "Extract Key Phrases from your text data"
}
}
},
"x-ms-connector-metadata": [
{
"propertyName": "Website",
"propertyValue": "https://maqsoftware.com/"
},
{
"propertyName": "Privacy Policy",
"propertyValue": "https://maqsoftware.com/privacystatement"
},
{
"propertyName": "Categories",
"propertyValue": "AI;Website"
}
],
"definitions": {},
"parameters": {},
"responses": {},
"securityDefinitions": {
"API Key": {
"type": "apiKey",
"in": "header",
"name": "APIKey"
}
},
"security": [
{
"API Key": []
}
],
"tags": []
}

Просмотреть файл

@ -0,0 +1,23 @@
{
"properties": {
"connectionParameters": {
"api_key": {
"type": "securestring",
"uiDefinition": {
"displayName": "API Key",
"description": "The API Key for this api",
"tooltip": "Provide your API Key",
"constraints": {
"tabIndex": 2,
"clearText": false,
"required": "true"
}
}
}
},
"iconBrandColor": "#FFFFFE",
"capabilities": [],
"publisher": "MAQ Software",
"stackOwner": "MAQ Software"
}
}