POST Agents/AI/GetSummarizeSalePrompt
Some tooltip text!
• 3 minutes to read
• 3 minutes to read
POST /api/v1/Agents/AI/GetSummarizeSalePrompt
Return the prompt used to get a short summary of the activities on a sale.
Does not call the chatbot for a response. Used for transfering a summary to a chat session.
Query String Parameters
| Parameter Name | Type | Description |
|---|---|---|
| $select | string | Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. |
POST /api/v1/Agents/AI/GetSummarizeSalePrompt?$select=name,department,category/id
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: request
SaleId, NumSentences, Summary, IsoLangCode
| Property Name | Type | Description |
|---|---|---|
| SaleId | Integer | |
| NumSentences | Integer | |
| Summary | String | |
| IsoLangCode | String |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: ChatbotTurn
| Property Name | Type | Description |
|---|---|---|
| Timestamp | date-time | UTC timestamp for turn - when response was generated |
| UserPrompt | string | Text from the user |
| UserDisplayText | string | Optional display value to use instead of the the UserPrompt |
| BotResponse | string | Text from the chatbot |
| BotActions | object | optional dictionary of action buttons. Key = Display text, Value = Prompt text |
| Attachments | array | optional array of attachments - can be URL or Base64 encoded data |
Sample request
POST /api/v1/Agents/AI/GetSummarizeSalePrompt
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8
{
"SaleId": 531,
"NumSentences": 716,
"Summary": "atque",
"IsoLangCode": "ut"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"Timestamp": "2010-11-07T14:13:38.9068394+01:00",
"UserPrompt": "qui",
"UserDisplayText": "non",
"BotResponse": "dolorum",
"BotActions": {
"BotActions1": "accusantium",
"BotActions2": "sint"
},
"Attachments": [
"asperiores",
"qui"
]
}