Updated business assist connector readme and swagger files (#2143)
* Submit Business Assist connector for certification * Submit Business Assist connector for certification * Updated swagger text. * Fixing PR comments. * Fixing PR comments. * Updated readme.md file Updated readme.md file * Update apiDefinition.swagger.json
This commit is contained in:
sjagaleti
GitHub
Родитель
fd109aea71
Коммит
4b9a69c6aa
|
|
@ -16,6 +16,14 @@ APIs used by the connector are secured by Azure Active Directory (AD).
|
|||
* Register your application using [Azure Portal](https://portal.azure.com), by following the steps [here](https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app).
|
||||
* Create a new user and set the password.
|
||||
|
||||
## Create service principal for Business Assist
|
||||
Make a POST call to MS Graph API with Business Assist app Id (2b8844d8-6c87-4fce-97a0-fbec9006e140) as a payload to create service principal.
|
||||
POST https://graph.microsoft.com/v1.0/servicePrincipals
|
||||
Content-type: application/json
|
||||
{
|
||||
"appId": "2b8844d8-6c87-4fce-97a0-fbec9006e140"
|
||||
}
|
||||
|
||||
## Supported Operations
|
||||
The connector supports the following operations:
|
||||
|
||||
|
|
@ -55,6 +63,3 @@ The BA API Power Connector supports the following operations:
|
|||
* `Get Text Analytics Status`: Check on the status of a previously submitted text analysis job
|
||||
* `Get Text Analytics Result`: Retrieve the result of a completed text analysis job
|
||||
* `Create Self-Help Query`: Type query related to M365 product, and you will get the insights on how you can troubleshoot the issue and web search article links to learn more on how to address the issue.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -22,26 +22,26 @@
|
|||
"get": {
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "default",
|
||||
"description": "The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"OperationId": {
|
||||
"type": "string",
|
||||
"description": "Forecast operation Id"
|
||||
"description": "Job ID, use to get status and results."
|
||||
},
|
||||
"Name": {
|
||||
"type": "string",
|
||||
"description": "Forecast name"
|
||||
"description": "Job name submitted with request."
|
||||
},
|
||||
"Status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Forecast status"
|
||||
"description": "Status code of forecast job."
|
||||
},
|
||||
"Diagnostics": {
|
||||
"type": "string",
|
||||
"description": "Diagnostics message"
|
||||
"description": "Errors or warnings generated during job creation."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -57,7 +57,7 @@
|
|||
"in": "path",
|
||||
"required": true,
|
||||
"type": "string",
|
||||
"description": "Specify forecast job id.",
|
||||
"description": "The GUID returned from a `CreateForecast` call that represents a specific job submitted to the Forecast API.",
|
||||
"x-ms-url-encoding": "single"
|
||||
}
|
||||
]
|
||||
|
|
@ -67,7 +67,7 @@
|
|||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"description": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action.",
|
||||
"schema": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
|
|
@ -75,23 +75,23 @@
|
|||
"properties": {
|
||||
"Date": {
|
||||
"type": "string",
|
||||
"description": "Date"
|
||||
"description": "The date the forecast job was created."
|
||||
},
|
||||
"Forecast": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "Forecast"
|
||||
"description": "Forecast for the defined time period."
|
||||
},
|
||||
"Low": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "Low",
|
||||
"description": "Low end of the forecast range predicted.",
|
||||
"title": ""
|
||||
},
|
||||
"High": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "High"
|
||||
"description": "High end of the forecast range predicted."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -118,26 +118,26 @@
|
|||
"post": {
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "default",
|
||||
"description": "The `CreateForecast` API asynchronously accepts historical volume data, seasonality, and special date information and creates a forecast.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"OperationId": {
|
||||
"type": "string",
|
||||
"description": "OperationId"
|
||||
"description": "Job ID, use to get status and results"
|
||||
},
|
||||
"Name": {
|
||||
"type": "string",
|
||||
"description": "Name"
|
||||
"description": "User-defined name for the Forecast job"
|
||||
},
|
||||
"Status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Status"
|
||||
"description": "Status code of forecast job."
|
||||
},
|
||||
"Diagnostics": {
|
||||
"type": "string",
|
||||
"description": "Diagnostics"
|
||||
"description": "Errors or warnings generated during job creation"
|
||||
},
|
||||
"Results": {
|
||||
"type": "array",
|
||||
|
|
@ -194,17 +194,17 @@
|
|||
"properties": {
|
||||
"Name": {
|
||||
"type": "string",
|
||||
"description": "Support volume forecast job",
|
||||
"description": "User-defined name for the Forecast job.",
|
||||
"title": "Name"
|
||||
},
|
||||
"EndDateTime": {
|
||||
"type": "string",
|
||||
"description": "12/31/2022",
|
||||
"description": "End date for the forecasting. It can be `yyyymmdd`, `mm/dd/yyyy`, or other widely known date format.",
|
||||
"title": "Forecast end date"
|
||||
},
|
||||
"Seasonality": {
|
||||
"type": "string",
|
||||
"description": "Daily",
|
||||
"description": "Divide forecasts by time periods for comparison. Select at most two seasonality from (daily, weekly, monthly, quarterly, yearly).",
|
||||
"title": "Seasonality",
|
||||
"enum": [
|
||||
"None",
|
||||
|
|
@ -218,7 +218,7 @@
|
|||
},
|
||||
"IncludePredictionInterval": {
|
||||
"type": "boolean",
|
||||
"description": "false",
|
||||
"description": "Include prediction interval with results.",
|
||||
"title": "Include prediction interval",
|
||||
"enum": [
|
||||
true,
|
||||
|
|
@ -228,17 +228,17 @@
|
|||
},
|
||||
"inputDataJson": {
|
||||
"type": "string",
|
||||
"description": "[{\"Date\":\"2022-07-01\",\"Ticket\":\"195\",\"DAO\":\"20000\"},{\"Date\":\"2022-07-02\",\"Ticket\":\"774\",\"DAO\":\"20500\"}]",
|
||||
"description": "JSON-formatted version of the historical data. For example, ``[{\"Date\":\"2022-07-01\",\"Ticket\":\"195\",\"DAO\":\"20000\"},{\"Date\":\"2022-07-02\",\"Ticket\":\"774\",\"DAO\":\"20500\"}]`",
|
||||
"title": "History data JSON"
|
||||
},
|
||||
"DateTimeColumnName": {
|
||||
"type": "string",
|
||||
"description": "Date",
|
||||
"description": "Column header for the column containing data and time information.",
|
||||
"title": "Date property name"
|
||||
},
|
||||
"VolumeColumnName": {
|
||||
"type": "string",
|
||||
"description": "Ticket",
|
||||
"description": "Column header for the column containing volume data.",
|
||||
"title": "Volume property name"
|
||||
},
|
||||
"AdjustmentColumnNames": {
|
||||
|
|
@ -254,31 +254,31 @@
|
|||
},
|
||||
"SpecialDateDataJson": {
|
||||
"type": "string",
|
||||
"description": "[{\"Date\":\"2021-10-28\",\"Name\":\"IgniteDay1\"}]",
|
||||
"description": "JSON-formatted string containing special date data. [{\"Date\":\"2021-10-28\",\"Name\":\"IgniteDay1\"}]",
|
||||
"title": "Special date data JSON",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
"SpecialDateAdjustmentDataJson": {
|
||||
"type": "string",
|
||||
"description": "[{\"Date\":\"2022-10-01\",\"Ratio\":\"-0.3\"}]",
|
||||
"description": "JSON-formatted string containing adjustments to make on special dates. [{\"Date\":\"2022-10-01\",\"Ratio\":\"-0.3\"}]",
|
||||
"title": "Special date adjustment data JSON",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
"SpecialDateColumnName": {
|
||||
"type": "string",
|
||||
"description": "Date",
|
||||
"title": "Special date property name",
|
||||
"title": "Name of the column in the `specialDateFileName` listing dates for special days and holidays.",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
"SpecialDateEventColumnName": {
|
||||
"type": "string",
|
||||
"description": "Name",
|
||||
"title": "Special date event property name",
|
||||
"title": "Name of the column in the `specialDateFilename` listing names of special days and holidays.",
|
||||
"x-ms-visibility": "advanced"
|
||||
},
|
||||
"SpecialDateAdjustmentColumnName": {
|
||||
"type": "string",
|
||||
"description": "Ratio",
|
||||
"description": "Name of the column in the special event data describing the adjustments to make.",
|
||||
"title": "Special date adjustment property name",
|
||||
"x-ms-visibility": "advanced"
|
||||
}
|
||||
|
|
@ -303,7 +303,7 @@
|
|||
"post": {
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "default",
|
||||
"description": "The request has been accepted for processing, but the processing has not been completed. The request might or might not eventually be acted upon, as it might be disallowed when processing actually takes place.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -322,7 +322,7 @@
|
|||
},
|
||||
"Diagnostics": {
|
||||
"type": "string",
|
||||
"description": "Diagnostics"
|
||||
"description": "Errors or warnings generated during job creatio"
|
||||
},
|
||||
"Results": {
|
||||
"type": "array",
|
||||
|
|
@ -379,15 +379,15 @@
|
|||
"properties": {
|
||||
"RecordId": {
|
||||
"type": "string",
|
||||
"description": "RecordId"
|
||||
"description": "A unique identifier is assigned to each record."
|
||||
},
|
||||
"Text": {
|
||||
"type": "string",
|
||||
"description": "Text"
|
||||
"description": "The text associated with a record."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "InputData"
|
||||
"description": "An array of records that consist of a `recordId` and the `text` of the record."
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -399,13 +399,13 @@
|
|||
"get": {
|
||||
"responses": {
|
||||
"202": {
|
||||
"description": "default",
|
||||
"description": "The `TextAnalyticsStatus` API accepts a TextAnalytics `operationId` and returns the status of the TextAnalytics job.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"OperationId": {
|
||||
"type": "string",
|
||||
"description": "Clustering operation Id"
|
||||
"description": "The unique identifier assigned during and returned by the `CreateTextAnalytics` operation."
|
||||
},
|
||||
"Name": {
|
||||
"type": "string",
|
||||
|
|
@ -414,11 +414,11 @@
|
|||
"Status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Clustering Status"
|
||||
"description": "Code showing status of clustering job."
|
||||
},
|
||||
"Diagnostics": {
|
||||
"type": "string",
|
||||
"description": "Diagnostics message"
|
||||
"description": "Errors or warnings generated during job creation"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -444,18 +444,18 @@
|
|||
"get": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"description": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"OperationId": {
|
||||
"type": "string",
|
||||
"description": "OperationId"
|
||||
"description": "The unique identifier assigned during and returned by the `CreateTextAnalytics` operation."
|
||||
},
|
||||
"Status": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Status"
|
||||
"description": "Code showing status of topic clustering job"
|
||||
},
|
||||
"Results": {
|
||||
"type": "array",
|
||||
|
|
@ -464,32 +464,32 @@
|
|||
"properties": {
|
||||
"RecordId": {
|
||||
"type": "string",
|
||||
"description": "RecordId"
|
||||
"description": "Unique identifier for each individual response item."
|
||||
},
|
||||
"Cluster_Id": {
|
||||
"type": "integer",
|
||||
"format": "int32",
|
||||
"description": "Cluster_Id"
|
||||
"description": "Unique identifier given to each topic cluster."
|
||||
},
|
||||
"Cluster_Probability": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "Cluster_Probability"
|
||||
"description": "Confidence of the machine learning models regarding the clustering of the topic."
|
||||
},
|
||||
"Cluster_Label": {
|
||||
"type": "string",
|
||||
"description": "Cluster_Label"
|
||||
"description": "Text label given to each cluster."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Results"
|
||||
"description": "An array of records returned by a Topic clustering job."
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"summary": "Get text analytic job result",
|
||||
"description": "Get text analytic job results by using job id.",
|
||||
"description": "The `TextAnalyticsResult` API accepts a TextAnalytics `operationId` and returns the results of the completed TextAnalytics job.",
|
||||
"operationId": "GetClusteringResult",
|
||||
"x-ms-visibility": "internal",
|
||||
"parameters": [
|
||||
|
|
@ -508,7 +508,7 @@
|
|||
"post": {
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "default",
|
||||
"description": "Standard response for successful HTTP requests. The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request the response will contain an entity describing or containing the result of the action.",
|
||||
"schema": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
|
|
@ -519,20 +519,20 @@
|
|||
"properties": {
|
||||
"Title": {
|
||||
"type": "string",
|
||||
"description": "Title"
|
||||
"description": "Solution or article title."
|
||||
},
|
||||
"Details": {
|
||||
"type": "string",
|
||||
"description": "Description"
|
||||
"description": "Preview text of article or content."
|
||||
},
|
||||
"SolutionConfidence": {
|
||||
"type": "number",
|
||||
"format": "float",
|
||||
"description": "Confidence"
|
||||
"description": "Algorithmic confidence score of the confidence the solution is relevant to the query."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Solutions"
|
||||
"description": "Instant answer to the user query. Contains `title`, `details` and `SolutionConfidence` score."
|
||||
},
|
||||
"WebSearchResults": {
|
||||
"type": "array",
|
||||
|
|
@ -541,26 +541,26 @@
|
|||
"properties": {
|
||||
"Title": {
|
||||
"type": "string",
|
||||
"description": "Title"
|
||||
"description": "Solution or article title."
|
||||
},
|
||||
"Details": {
|
||||
"type": "string",
|
||||
"description": "Details"
|
||||
"description": "Preview text of article or content."
|
||||
},
|
||||
"URL": {
|
||||
"type": "string",
|
||||
"description": "URL"
|
||||
"description": "Link to full content of the `WebSearchResults`."
|
||||
}
|
||||
}
|
||||
},
|
||||
"description": "Insights"
|
||||
"description": "Related article from the web search.Contains the `title`, `details`, and `url` found through a web search."
|
||||
},
|
||||
"ServiceIncidents": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"Id": {
|
||||
"properties": {
|
||||
"type": "string",
|
||||
"description": "Id"
|
||||
},
|
||||
|
|
@ -627,12 +627,12 @@
|
|||
"properties": {
|
||||
"QueryText": {
|
||||
"type": "string",
|
||||
"description": "Outlook doesn't work",
|
||||
"description": "Text of the user's query.",
|
||||
"title": "Problem Description"
|
||||
},
|
||||
"Locale": {
|
||||
"type": "string",
|
||||
"description": "en-US",
|
||||
"description": "Locale to use for the solution returned.",
|
||||
"title": "Locale"
|
||||
}
|
||||
},
|
||||
|
|
@ -684,4 +684,4 @@
|
|||
}
|
||||
],
|
||||
"tags": []
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче