Skip to content

Commit 83d22db

Browse files
authored
MAQTextAnalytics (Non-Microsoft Publisher) (#1504)
* Added custom connector files for MAQTextAnalytics * Updated brand color * Update apiDefinition.swagger.json
1 parent be3d8f9 commit 83d22db

File tree

3 files changed

+291
-0
lines changed

3 files changed

+291
-0
lines changed
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# MAQ Text Analytics Connector
2+
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.
3+
4+
# Pre-requisites
5+
You will need the following to proceed:
6+
- A Microsoft Power Apps or Microsoft Power Automate plan with custom connector feature
7+
- 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).
8+
9+
# Deploying the connector
10+
```
11+
paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json
12+
```
13+
14+
# Supported Operations
15+
The connector supports the following operations:
16+
- `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
17+
- `PII Scrubber`: Scrubs Personally Identifiable Information (PII) data from your text based on configured entities. Returns text devoid of PII data
18+
- `Key Phrase Extractor`: Extracts Key Phrases from your text data. Returns a comma separated list of Key Phrases for each document
Lines changed: 250 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,250 @@
1+
{
2+
"swagger": "2.0",
3+
"info": {
4+
"version": "1.0.0",
5+
"title": "Text Analytics",
6+
"description": "Discover meaningful insights in your text data. Perform Sentiment Analysis, extract Key Phrases and scrub PII Data from your text data.",
7+
"contact": {
8+
"name": "MAQ Software Sales",
9+
"url": "https://maqsoftware.com/contact",
10+
"email": "Sales@MAQSoftware.com"
11+
}
12+
},
13+
"host": "maqtextnalyticssdk.azure-api.net",
14+
"basePath": "/",
15+
"schemes": [
16+
"https"
17+
],
18+
"consumes": [],
19+
"produces": [
20+
"application/json"
21+
],
22+
"paths": {
23+
"/text/SentimentClassifier": {
24+
"post": {
25+
"summary": "Sentiment Classifier",
26+
"description": "Perform Sentiment Analysis of your text data",
27+
"operationId": "SentimentClassifier",
28+
"parameters": [
29+
{
30+
"name": "body",
31+
"in": "body",
32+
"schema": {
33+
"type": "object",
34+
"properties": {
35+
"data": {
36+
"type": "array",
37+
"items": {
38+
"type": "object",
39+
"properties": {
40+
"id": {
41+
"type": "integer",
42+
"format": "int32",
43+
"description": "id"
44+
},
45+
"text": {
46+
"type": "string",
47+
"description": "text"
48+
}
49+
}
50+
},
51+
"description": "data"
52+
}
53+
},
54+
"default": {
55+
"data": [
56+
{
57+
"id": 5,
58+
"text": "store wont launch but its coo when it worked"
59+
},
60+
{
61+
"id": 1,
62+
"text": "the best product"
63+
},
64+
{
65+
"id": 2,
66+
"text": "Very easy to understand and use the design lab!"
67+
},
68+
{
69+
"id": 3,
70+
"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."
71+
},
72+
{
73+
"id": 4,
74+
"text": "quality products, and the warranty service has been outstanding"
75+
},
76+
{
77+
"id": 5,
78+
"text": "store wont launch but its coo when it worked"
79+
}
80+
]
81+
}
82+
},
83+
"required": true
84+
}
85+
],
86+
"responses": {
87+
"200": {
88+
"description": "200",
89+
"schema": {
90+
"type": "array",
91+
"items": {
92+
"type": "object",
93+
"properties": {
94+
"id": {
95+
"type": "integer",
96+
"format": "int32",
97+
"description": "id"
98+
},
99+
"sentiment": {
100+
"type": "number",
101+
"format": "float",
102+
"description": "sentiment"
103+
}
104+
}
105+
}
106+
}
107+
}
108+
}
109+
}
110+
},
111+
"/text/PIIScrubber": {
112+
"post": {
113+
"responses": {
114+
"200": {
115+
"description": "200",
116+
"schema": {
117+
"type": "object",
118+
"properties": {
119+
"scrubbed_text": {
120+
"type": "string",
121+
"description": "scrubbed_text"
122+
}
123+
}
124+
}
125+
}
126+
},
127+
"operationId": "PIIScrubber",
128+
"summary": "Scrub PII Data",
129+
"parameters": [
130+
{
131+
"name": "body",
132+
"in": "body",
133+
"required": false,
134+
"schema": {
135+
"type": "object",
136+
"properties": {
137+
"data": {
138+
"type": "string",
139+
"description": "data"
140+
},
141+
"entity_list": {
142+
"type": "string",
143+
"description": "entity_list"
144+
}
145+
}
146+
}
147+
}
148+
],
149+
"description": "Scrub PII data from your text based on configured entities"
150+
}
151+
},
152+
"/text/KeyPhrase": {
153+
"post": {
154+
"responses": {
155+
"200": {
156+
"description": "200",
157+
"schema": {
158+
"type": "array",
159+
"items": {
160+
"type": "object",
161+
"properties": {
162+
"KeyPhrase": {
163+
"type": "string",
164+
"description": "KeyPhrase"
165+
},
166+
"Score": {
167+
"type": "number",
168+
"format": "float",
169+
"description": "Score"
170+
},
171+
"Similar": {
172+
"type": "array",
173+
"items": {
174+
"type": "string"
175+
},
176+
"description": "Similar"
177+
}
178+
}
179+
}
180+
}
181+
}
182+
},
183+
"summary": "Key Phrase Extractor",
184+
"operationId": "KeyPhraseExtractor",
185+
"parameters": [
186+
{
187+
"name": "body",
188+
"in": "body",
189+
"required": false,
190+
"schema": {
191+
"type": "object",
192+
"properties": {
193+
"text": {
194+
"type": "string",
195+
"description": "text"
196+
},
197+
"keyphrases_count": {
198+
"type": "integer",
199+
"format": "int32",
200+
"description": "keyphrases_count"
201+
},
202+
"diversity_threshold": {
203+
"type": "number",
204+
"format": "float",
205+
"description": "diversity_threshold"
206+
},
207+
"alias_threshold": {
208+
"type": "number",
209+
"format": "float",
210+
"description": "alias_threshold"
211+
}
212+
}
213+
}
214+
}
215+
],
216+
"description": "Extract Key Phrases from your text data"
217+
}
218+
}
219+
},
220+
"x-ms-connector-metadata": [
221+
{
222+
"propertyName": "Website",
223+
"propertyValue": "https://maqsoftware.com/"
224+
},
225+
{
226+
"propertyName": "Privacy Policy",
227+
"propertyValue": "https://maqsoftware.com/privacystatement"
228+
},
229+
{
230+
"propertyName": "Categories",
231+
"propertyValue": "AI;Website"
232+
}
233+
],
234+
"definitions": {},
235+
"parameters": {},
236+
"responses": {},
237+
"securityDefinitions": {
238+
"API Key": {
239+
"type": "apiKey",
240+
"in": "header",
241+
"name": "APIKey"
242+
}
243+
},
244+
"security": [
245+
{
246+
"API Key": []
247+
}
248+
],
249+
"tags": []
250+
}
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
{
2+
"properties": {
3+
"connectionParameters": {
4+
"api_key": {
5+
"type": "securestring",
6+
"uiDefinition": {
7+
"displayName": "API Key",
8+
"description": "The API Key for this api",
9+
"tooltip": "Provide your API Key",
10+
"constraints": {
11+
"tabIndex": 2,
12+
"clearText": false,
13+
"required": "true"
14+
}
15+
}
16+
}
17+
},
18+
"iconBrandColor": "#FFFFFE",
19+
"capabilities": [],
20+
"publisher": "MAQ Software",
21+
"stackOwner": "MAQ Software"
22+
}
23+
}

0 commit comments

Comments
 (0)