Skip to main content

AI Summary

The AI Summary web part for Sprocket 365 is a powerful tool that automatically generates intelligent summaries of page content using OpenAI's GPT models. This web part analyzes the content on your SharePoint page and provides concise, AI-generated summaries in different tones to help users quickly understand the key information. The AI Summary web part is easy to use and can be customized to meet your specific needs. In this article, we will show you how to create and use the AI Summary web part in Sprocket 365.

Features​

  • Automatic Content Analysis: Automatically extracts and analyzes content from SharePoint pages
  • AI-Powered Summarization: Uses OpenAI GPT-3.5-turbo to generate intelligent summaries
  • Multiple Tone Options: Choose between Professional, Casual, or Technical summary styles
  • Intelligent Caching: Caches summaries to avoid redundant API calls and improve performance
  • Version Detection: Automatically detects page changes and regenerates summaries when needed

Configurations​

After you select the Sprocket AI Summary web part, click the Configure Web Part button or icon on the menu on the left of the web part to open the Configuration section on the right. In this section, you can perform the following configurations:

  1. On page 1, configure the following in the Display Options section:

    FieldDescription
    Show TitleClick to enable title display of the web part.
    Show in PanelClick to enable display of items in panel.
    Summary ToneFrom the drop-down list, select Professional, Casual, or Technical. This determines the style and tone of the AI-generated summary.

  1. Global Settings Configuration (Required): Alt text

    Before the AI Summary web part can function, you must configure the OpenAI API key in the global settings:

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

  2. Once all the required updates and configurations are performed, click Republish button to publish the page.

FAQs​

1. How do I change the AI Summary Web Part Title?
To change the Title of the AI Summary web part, you need to first Edit the page, once in Edit mode you can highlight the text and simply type to replace your new Title.

2. What does the Panel setting do?
The panel setting places a fine grey border around the web part and provides a solid white background. This setting is best used if you are using solid background colours in your sections.

3. 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

4. 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.

5. 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.

6. Can I manually regenerate a summary?
The web part automatically generates summaries when needed. Manual regeneration is handled automatically when page content changes.

7. 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.