Newer Version Available

This content describes an older version of this product. View Latest

Get Answers From Data 360 Sources

Search a data model object using a natural language query and return an answer.
Resource
/connect/search/sobjects/objectApiName/answer
HTTP method
GET
Example
1/services/data/v63.0/connect/search/sobjects/ssot__KnowledgeArticleVersion__dlm/answer?q=How can I setup the labs field service dashboards &htmlEncode=false
Response Body
1{
2   "content":"<p>To set up the <b>Salesforce Labs Field Service Dashboards</b>, you can download a free package from the Salesforce Labs AppExchange. This package includes three standard dashboards that help track key metrics and performance in your field service operations. These dashboards can be customized to meet your specific needs. Key metrics tracked include:</p><ul><li>Number of completed appointments by a resource</li><li>Management by territory and utility</li><li>Total hours worked by resource</li><li>Number of maintenance plan check-ins</li><li>Resource capacity by territory</li><li>Upcoming priority appointments</li><li>Total number of completed appointments by week</li><li>Products consumed by work orders</li><li>Average appointment and travel times</li></ul><p>The dashboards available are:</p><ul><li><b>System Administrator Dashboard</b>: Displays metrics such as products needed and consumed, and overall performance for each type of work.</li><li><b>Inventory Manager Dashboard</b>: Shows how products are consumed and used by work order types.</li><li><b>Service Manager Dashboard</b>: Focuses on work performance of resources and additional work order metrics.</li></ul><p>To download the dashboards, click 'Get It Now' on the Field Service Dashboards page on AppExchange.</p>",
3   "searchObjects":[
4      {
5         "objectApiName":"ssot__KnowledgeArticleVersion__dlm",
6         "searchResults":[
7            {
8               "id":"q9i000003855734AAA",
9               "fields":{
10                  "ssot__Name__c":{
11                     "value":"Set Up Salesforce Labs Field Service Dashboards",
12                     "displayValue":null
13                  },
14                  "ssot__Id__c":{
15                     "value":"ka0SG00000KKV8zYAH",
16                     "displayValue":null
17                  }
18               }
19            },
20            {
21               "id":"q9i000007146011AAA",
22               "fields":{
23                  "ssot__Name__c":{
24                     "value":"Set Up Field Service",
25                     "displayValue":null
26                  },
27                  "ssot__Id__c":{
28                     "value":"ka0SG00000KKWrRYAX",
29                     "displayValue":null
30                  }
31               }
32            }
33         ],
34         "displayFields":[
35            "ssot__Name__c",
36            "ssot__Id__c"
37         ],
38         "orderBy":[
39            
40         ],
41         "status":null,
42         "pageInfo":{
43            "offset":0,
44            "pageSize":2,
45            "hasNextPage":false
46         },
47         "spellCorrectionInfo":null
48      }
49   ],
50   "llmGenerationId":"chatcmpl-BaOnl0VoiNqJS2TZvYsx8chmyY93W",
51   "parameters":{
52      "q":"How can I set up the labs field service dashboards"
53   },
54   "metadata":{
55      "ssot__KnowledgeArticleVersion__dlm":{
56         "objectApiName":"ssot__KnowledgeArticleVersion__dlm",
57         "label":"Knowledge Article Version",
58         "labelPlural":"Knowledge Article Version",
59         "themeInfo":{
60            "color":"FF538A",
61            "iconUrl":"https://orgfarm-0a84d99a1a.test1.my.pc-rnd.salesforce.com/img/icon/t4v35/custom/custom68.svg"
62         },
63         "fields":{
64            "ssot__Id__c":{
65               "field":"ssot__Id__c",
66               "fieldApiName":"ssot__Id__c",
67               "domain":"ssot__KnowledgeArticleVersion__dlm",
68               "label":"Knowledge Article Version Id",
69               "fieldType":"String",
70               "sortable":true,
71               "filterable":true,
72               "highlightable":false
73            },
74            "ssot__Name__c":{
75               "field":"ssot__Name__c",
76               "fieldApiName":"ssot__Name__c",
77               "domain":"ssot__KnowledgeArticleVersion__dlm",
78               "label":"Name",
79               "fieldType":"String",
80               "sortable":true,
81               "filterable":true,
82               "highlightable":false
83            }
84         }
85      }
86   }
87}