Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

HAi Request Summarizer

Important

HAi is currently in a closed beta, speak to customer success should you want to take part.

Setup

Once enabled there are some settings explained in the table below that allow for some customization on the amount of date and what timeline update types are used when generating the request summary, these can be updated by access application settings for service manager.

Setting Description
generativeAi.requestSummary.availablePostTypes List of timeline update types sent to the summarizer, this allows you to add in or remove certain update types to be included or excluded from the request summary by default this is set to Authorization,Customer,Email,Escalate,update
generativeAi.requestSummary.format Format the request summary is generated in (Structured or Conversational)
generativeAi.requestSummaryAutoUpdates Auto generate Request Summary when a request is opened
generativeAi.limits.activitySteamPosts Limit on the number of posts returned and passed to the summarizer, by default this is set to 100 ordered by most recent activity
generativeAi.limits.activitySteamComments Limit on the number of comments per post returned and passed to the summarizer, by default this is set to 100
generativeAi.limits.activitySteamContentLength Limit on the maximum content length of a post or comment, anything longer is truncated and passed to the summarizer, by default this is set to 1000

Limits

The reason for the limits is to minimize the likely hood of a request summary request to our AI Services reaching the total number of input tokens allowed, currently 128,000. Very long timelines with lots of large posts can go over this limit. Internally there is a safe guard that even if you crank the limits up a very large timeline will still end up truncated in an effort to prevent the AI Service returning an error. The maximum input tokens has been slowly increasing over the months and some services allow for much much larger inputs, something that may be investigated should the limits prove problematic for customers.

In This Document