Skip to main content

OpenAI Summary Agent

An OpenAI Summary Agent generates summaries from selected in-world data sources, such as Chat, Private Chat, Agent Chat, and Transcription.

Step 1: Create an OpenAI Account

Visit the OpenAI Signup Page and register an account.

Step 2: Generate an OpenAI API Key

  1. Go to the OpenAI Dashboard.
  2. Navigate to the API Keys section.
  3. Click Create new secret key.
  4. Provide a name tag, select a project, and set security permissions.
  5. Copy and store your API key safely, as it will not be shown again.

Create API Key Button

Once you’ve set up an OpenAI assistant, you can integrate it into your XR project.

Step 3: Integrate Your OpenAI Agent with XR Creator Studio

1. Add an AI Agent Element in XR Creator

  1. Open your project in the XR Editor.
  2. In the Elements Menu, select AI Agent.

AI Agent in Elements Menu

2. Configure AI Agent Properties

In the Properties Panel, set the parameters required to connect your assistant.

Create API Key Button

PropertyDescription
Agent NameThe name that will appear in the chat interface.
ProviderSelect OpenAI Summary.
API KeyEnter your secret API key securely.
Data SourcesSelect the sources the agent should use to generate summaries. Available options include Chat, Private Chat, Agent Chat, and Transcription.

Data Source Requirements

Some data sources depend on additional agents being present in the scene.

Data SourceRequirement
ChatChat option should be enabled.
Private ChatChat option should be enabled.
Agent ChatRequires at least one AI Agent to be present in the scene. The Summary Agent can only summarize conversations generated by active agents.
TranscriptionRequires a Transcription Agent to be present in the scene. Without a Transcription Agent, voice conversations will not be converted into text and cannot be included in summaries.

🔹 Note: If a required agent is not present, the Summary Agent will still function, but no data will be collected from that source.

Once the properties are configured, publish your project to make the Summary Agent available in your Verse.

Generate Summary

The Generate Summary feature allows participants to create AI-generated summaries of activity within a Metaverse room. Summaries can be generated from chat messages, voice transcriptions, private conversations, and agent interactions, making it easy to review discussions, decisions, and key topics without reading through the entire session.

MUD User Interface

Accessing Generate Summary

  1. Join a Metaverse room.
  2. Open the More Options menu () from the bottom toolbar.
  3. Under Collaboration, select Generate Summary.
  4. Select your desired Time Range.
  5. Choose the File Format.
  6. Select one or more Data Sources.
  7. Click Generate.
  8. When processing is complete, a notification will appear indicating that the summary is ready.
  9. Click Download from the notification.
  10. Save the generated file to your device.

The downloaded file will contain the AI-generated summary in the selected format.

Configuring a Summary

Before generating a summary, you can customize several options.

MUD User Interface

  • Time Range

Choose the period of activity you want to summarize.

Available options include:

OptionDescription
Last 15 minSummarizes activity from the previous 15 minutes.
Last 30 minSummarizes activity from the previous 30 minutes.
Last 1 hourSummarizes activity from the previous hour.
Last 3 hoursSummarizes activity from the previous 3 hours.
Last 24 hoursSummarizes activity from the previous 24 hours.
CustomSelect a custom date and time range.

🔹 Note: Longer time ranges may take slightly longer to process depending on the amount of data.

  • File Format

Select the format for the generated summary.

FormatDescription
PDFGenerates a downloadable PDF document suitable for sharing, printing, or archiving.
MarkdownCreates a Markdown file that can be edited or used in documentation systems.
TextGenerates a plain text file for simple viewing or import into other tools.
  • Data Sources

Choose which room data should be analyzed when generating the summary.

SourceDescription
ChatPublic chat messages exchanged in the room.
Private ChatDirect messages exchanged between participants.
Agent ChatConversations involving AI Agents in the room.
TranscriptionSpeech-to-text transcripts generated from voice conversations.

You can select one or multiple data sources depending on the information you want included in the summary.

Examples:

  • Selecting Chat and Transcription summarizes both written messages and spoken conversations.
  • Selecting Agent Chat focuses on interactions with AI agents.
  • Selecting all sources creates a comprehensive room summary.