<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style>
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
.fr-fic.fr-dii {
float: none; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fil {
float: left; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fir {
float: right; margin: 5px auto;
}
img.fr-dib.fr-fir {
margin-right: 0; text-align: right;
}
img.fr-dib.fr-fil {
margin-left: 0; text-align: left;
}
img.fr-dib {
margin: 5px auto; display: block; float: none;
}
img.fr-bordered {
box-sizing: content-box; border: solid 5px #CCC;
}
img.fr-shadow {
box-shadow: 10px 10px 5px 0px #cccccc;
}
img.fr-rounded {
border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;
}
</style><p><strong>In this guide we will cover:</strong></p><p><strong>- What the AI Query Builder is</strong></p><p><strong>- Writing a Prompt</strong></p><p><br></p><p><br></p><p><strong>Admin Guides:</strong></p><ul><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/1851/" target="_blank" rel="noopener noreferrer"><strong>General Settings (Reporting)</strong></a></li></ul><p><strong><br></strong></p><p><strong>Related Guides:</strong></p><ul><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/917/" target="_blank" rel="noopener noreferrer"><strong>Charts and Graphs in Reports</strong></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/1249/" target="_blank" rel="noopener noreferrer"><strong>Halo In-App Dashboard</strong></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/887/" target="_blank" rel="noopener noreferrer"><strong>Reports and Scheduling</strong></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/1563/" target="_blank" rel="noopener noreferrer"><strong>Report Builder</strong></a></li><li style="font-weight: bold;"><a href="https://usehalo.com/haloitsm/guides/2375/" target="_blank" rel="noopener noreferrer"><strong>Report Data Sources</strong></a></li></ul><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">What the AI Query Builder is</span></strong></p><p>The report builder uses an AI Assistant utilising the latest GPT-4 model. Trained using a schema of the Halo database, this assistant can query from the following tables and tables associated with them:</p><p><br></p><ul><li>Tickets</li><li>Actions</li><li>Approvals</li><li>Agents</li><li>Users</li><li>Sites</li><li>Customers</li><li>Assets</li><li>Items</li><li>Invoices</li><li>Quotations</li><li>Sales Orders</li><li>Purchase Orders</li></ul><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">Writing a Prompt</span></strong></p><p>To generate a report, first select the "Use AI Query Builder" option from the data source dropdown. This will then display a text field to enter your prompt into.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImZhM2VmZmUwLTM4MDktNGY5ZC1iMGQyLWJjYWY5YjcwN2Q4OCJ9.pcOnLtitTOxJjXYPzGfzlUIyWqYbjo7qQ3DrhwXagzw" class="fr-fic fr-fil fr-dib" style="width: 977px; height: 570.274px;" width="975" height="570"></p><p><span style="font-size: 10pt;"><strong>Fig 1. View of the AI Query Builder</strong></span></p><p><br></p><p>When writing your prompt make sure to explain exactly what fields you want included in your query and what tables you're querying. If referencing any user-defined values, make sure you define what they mean. For example, if asking for change requests awaiting approval, you need to specify that "Change Request" is the name of a ticket type and "Awaiting Approval" is a ticket status.</p><p><br></p><p>If trying to query custom fields, make sure to use the CF name of the custom field in your prompt.</p><p><br></p><p>Similarly, if querying asset fields, make sure to include AF before the name of the asset field in your prompt</p><p><br></p><p>Once you are happy with the prompt you have entered, click the "Generate Report" button. This will send the prompt off to the AI assistant. </p><p>Generating the report can take anywhere from 20 seconds to a couple of minutes. Make sure to remain on the page and not refresh it until the report query has been generated.</p><p><br></p><p>Once the response is received from the AI assistant, a message will be displayed if it succeeded in generating the query and if the query runs successfully on the database.</p><p><br></p><p><strong><em>Note: As this is cutting-edge functionality, there are limitations to what the AI can query. If the query returned is not 100% correct, the message displayed should help you resolve any issues with it. We are continuously improving this functionality to improve the complexity of the queries that can be generated and to reduce the number of issues with the queries returned. </em></strong></p><p><br></p><p><strong><span style="font-size: 12pt;">Example Prompts</span></strong></p><p>Below is a list of prompts you can use to get started with the AI Report Builder, giving you a good foundation to build out a more complex query.</p><p><br></p><ul><li>Write a query to return the summary and ID of all incident tickets opened this week. 'Incident' is the name of a ticket type.</li><li>Write a query to return the asset number, site, and asset type name of all active assets.</li></ul><p>If you have knowledge of SQL, this can also be a good method to get a base of a report to build out.</p>
