Skip to main content

AI Summary

The Sprocket AI Summary web part automatically generates concise, AI-powered summaries of your page content using OpenAI. Help your readers quickly understand the key points of long articles and documents without reading the entire page.

Features​

  • Automatic content extraction and summarization from page text
  • Multiple tone options to match your content style (Professional, Casual, or Technical)
  • Smart caching system that stores generated summaries and only regenerates when page content changes
  • Intelligent version tracking to ensure summaries stay current with page updates
  • Token-optimized content processing for cost-effective AI usage
  • Seamless integration with your page publishing workflow

Prerequisites​

Before using the AI Summary web part, you must configure your OpenAI API key in Sprocket settings:

  1. Navigate to Advanced Settings in the Sprocket 365 configuration
  2. Set the openAIAPIKey value with a valid OpenAI API key
  3. The API key must start with 'sk-' and have sufficient credits

Without a configured API key, the web part will display a message indicating that configuration is required.

Configuration​

Adding the Web Part​

  1. If you are not already in edit mode, click Edit at the top right of your page.
  2. Click the + icon to add a new web part to your page.
  3. Search for and select Sprocket AI Summary.
  4. Configure the web part settings using the property pane on the right.

Configuration Options​

The AI Summary web part offers the following configuration settings:

SettingDescriptionOptionsDefault
Summary ToneSelect the tone and style for the AI-generated summary• Professional - Formal, business-appropriate language
• Casual - Conversational, approachable tone
• Technical - Detailed, technical terminology		Professional
Show TitleEnable or disable the web part title displayOn / OffOff
Show in PanelDisplay the web part content in a panel layoutOn / OffOff

Tips for Best Results​

  • Content Length: The web part works best with pages that have substantial text content (at least a few paragraphs)
  • Tone Selection: Choose the tone that matches your audience - use Professional for business content, Casual for community pages, or Technical for developer documentation
  • Summary Placement: Consider placing the AI Summary web part near the top of your page so readers can quickly see the key points

FAQs​

1. What is the difference between the tone options?

Professional: Formal, business-appropriate tone suitable for corporate communication Casual: Friendly, conversational tone that is easy to read Technical: Precise language suitable for technical documentation

2. Why do I need an OpenAI API key?

The AI Summary web part uses OpenAI's GPT-3.5-turbo model to generate summaries. You need a valid OpenAI API key with sufficient credits to use this feature.

3. What happens if the API key is invalid?

If the OpenAI API key is missing or invalid, the web part will display an error message with instructions to configure the API key in Advanced Settings.

4. What if the page has very little content?

The web part requires a minimum of 50 characters of content to generate a meaningful summary. If content is too short, it will display an appropriate message.