Skip to main content

Core Concepts

This page outlines the fundamental concepts used throughout the PlaySafe platform and SDK.

General Concepts​

  • Action Policy: A set of rules defined in the PlaySafe dashboard that dictate automatic actions to be taken based on detected events (e.g., toxicity levels). Example: Temporarily mute a player's voice chat if hate speech is detected. Action Policies
  • Action Log: A record available in the dashboard detailing every automated action taken against players according to the Action Policies. Contains context like the trigger, the action taken, duration, and associated evidence (e.g., audio snippet, transcript). Action Logs
  • Audio Event: A segment of recorded player audio captured by the SDK for processing (e.g., moderation analysis, Sensei voice input).
  • App Key: Your unique identifier for authenticating your game application with the PlaySafe backend services. This is required when initializing the SDK.

Moderation Concepts​

  • Telemetry: Contextual data (like UserId, RoomId, Language) sent alongside audio events or reports to improve analysis and provide necessary information for moderation actions.
  • Manual Report: An action taken by a player within the game to report another player for misconduct (e.g., toxicity, cheating). Logged by PlaySafe via the ReportUser function.
  • Manual Mute: An action taken by a player to locally mute another player. Can also be logged via the ReportUser function for tracking.
  • ActionItem: An object returned by the moderation system (via the OnActionEvent delegate) detailing a recommended action (e.g., TIMEOUT, MUTE), the reason, and suggested duration based on policy violations detected in an audio event.

Sensei Concepts​

Senseis are intelligent AI agents for player interaction.

  • Persona: The foundational "brain" defining a Sensei's personality and base knowledge. Created and configured in the PlaySafe dashboard. Sensei Edit Dialog
  • Document: A text-based source of knowledge added to a Persona. A Persona uses the information in its associated documents to answer player questions.
  • Sensei: A specific, interactable instance of a Persona within your game. Players chat with Senseis.
  • Sensei Chat: A conversational session between a player and a Sensei, managed via the SDK (start, send messages, end).
  • Sensei Poll: A simple survey or question attached to a Sensei, allowing players to provide structured feedback via the SDK.

Configuration Concepts​

  • Remote Config: Game-specific settings managed via the PlaySafe dashboard and fetched by the SDK upon initialization. Allows dynamic adjustments without requiring a game update. Remote Config
    • Use Case Example: Setting a samplingRate (e.g., 0.1 for 10%) to control what percentage of player audio is processed by PlaySafe for moderation, helping manage costs and focus resources.

API Interaction Notes​

  • Authorization: The primary authorization mechanism is the App Key provided during PlaySafeManager setup.