Adding article summaries to knowledge base articles


You can insert an article summary component into your help center article to display a concise description of the article content in a shaded box at the top of your article. Users can scan the summary to gain an overview of the article content and determine if it contains the information they're looking for.


What's my plan?







All Suites

Team, Growth, Professional, Enterprise, or Enterprise Plus










Support with

Guide Professional or Enterprise







Verified AI summary ◀▼
Add a summary to your help center articles to give users a quick overview of the content. You can manually type a summary or use AI to generate one. AI-generated summaries can be previewed, regenerated, and updated as needed. This feature helps users quickly determine if the article contains the information they need.




You can insert an article summary component into your help center article to
display a concise description of the article content in a shaded box at the
top of your article. Users can scan the summary to gain an overview of the
article content and determine if it contains the information they're looking
for.

This article contains the following topics:
Adding article summaries
Adding AI-generated summaries


Related articles
Turning on and off
AI-generated article summaries




Adding article summaries

You can create blank article summaries in the article editor, then type
your summaries in the text box.
To add an article summary

In the help center or
Knowledge
admin, create or edit an article.
Click the Article components button ( ) in the article
editor toolbar, then select Summary.

Enter your summary in the Summary field.

Click Save.




Adding AI-generated summaries

AI-generated article summaries are article overviews that you create with
the Summary component in the article editor. With AI-generated
summaries, you can generate a concise description of the article,
preview the summary, then regenerate it if you aren't happy with the
result. You can publish the summary and regenerate a new summary
whenever the article is updated.
You can find information about supported languages
for AI article summaries in the Zendesk language support
article.

To add an AI-generated article summary
In the help center
or Knowledge
admin, create or edit an article.
Click the Article components button ( ) in the
article editor toolbar, then select
Summary.

Click in the Summary field to expose the AI menu,
then click Generate.
The
AI-generated summary appears in the shaded box. If
you want to regenerate the summary, click
Generate again until you are happy with the
content. To remove the AI-generated summary, click
the delete icon ( ).

Click Save.





//
const ai_summary_style = document.createElement('style');
ai_summary_style.innerHTML = `#styled-article-body{padding:0 0 0}#article-body #docs-ai-summary{background-color:#f3f3f3;border:1px solid #d3d3d3;padding:10px 10px 6px;margin-bottom:16px}#article-body #docs-ai-summary #docs-ai-summary-toggle{font-size:.9em;font-weight:700;margin-bottom:4px;cursor:pointer;display:flex;justify-content:space-between;align-items:center}#article-body #docs-ai-summary #docs-ai-summary-toggle #up-triangle{margin-left:auto;padding-right:10px;display:none}#article-body #docs-ai-summary #docs-ai-summary-toggle #down-triangle{margin-left:auto;padding-right:10px}#article-body #docs-ai-summary #docs-ai-summary-content{font-size:.9em;padding-left:25px;padding-right:25px;margin-bottom:12px}`;
document.head.appendChild(ai_summary_style);

const toggleAISummary = () => {
const summary = document.getElementById("docs-ai-summary-content");
const upTriangle = document.getElementById("up-triangle");
const downTriangle = document.getElementById("down-triangle");
if (summary.style.display === "none") {
summary.style.display = "block";
upTriangle.style.display = "none";
downTriangle.style.display = "inline";
} else {
summary.style.display = "none";
upTriangle.style.display = "inline";
downTriangle.style.display = "none";
}
};

document.getElementById("docs-ai-summary-toggle").addEventListener("click", toggleAISummary);
//

