Introduction

Welcome to the documentation of UGC Guard! This project is designed to help you manage user-generated content (UGC) effectively.

We offer a solution that enriches your existing software solution with AI-powered content moderation capabilities, enabling you to filter out unwanted content and ensure a safe environment for your users. This documentation will guide you through the setup, usage, and features of UGC Guard. Whether you're a developer looking to integrate our solution into your application or a reviewer seeking to understand how to use our tools, you'll find the information you need here.

What is content moderation?

Content moderation is the process of monitoring and managing user-generated content to ensure it adheres to community guidelines, standards and to legal requirements. Content moderation is not a bonus feature, but a necessity for any application that allows users to create and share content. It helps maintain a safe and respectful environment for all users, preventing the spread of harmful, offensive, or illegal content.

But content moderation can be a complex and time-consuming task, especially for applications with large user bases. UGC Guard aims to simplify this process by providing a comprehensive solution that leverages AI to pre-filter reports, enabling human reviewers to focus on the most relevant and critical cases. This not only improves the efficiency of the moderation process but also enhances the overall user experience by ensuring that harmful content is addressed quickly and effectively.

We furthermore enable developers to integrate content moderation capabilities into their applications without having to build everything from scratch. Our solution is designed to be flexible and adaptable, allowing you to tailor it to your specific needs and requirements. Whether you're building a social media platform, a community forum, or any other application that involves user-generated content, UGC Guard can help you manage and moderate that content effectively.

Awesome Features

UGC Guard comes with a range of powerful features to help you manage user-generated content effectively:

• AI-Powered Pre-Filtering: Use advanced AI models to pre-filter reports, reducing the workload for human reviewers. We support a variety of AI models, including OpenAI, DeepSeek, Gemini, Mistral, and Ollama. This allows you to choose the best model for your needs and ensures that reports are filtered based on your specific requirements.
• Intelligent Reporting: If a user reports already reported content, UGC Guard will automatically merge the reports, ensuring that reviewers only see unique reports.
• Context is what matters: UGC Guard provides context for each report, including the original content, additional content that is connected to the given content, the user who reported it, and any additional information that may be relevant. This helps reviewers make informed decisions.
• Media is important: UGC Guard supports media files, allowing users to report images, videos, and other media content. This ensures that all types of user-generated content can be effectively moderated. Furthermore, we make sure, that if the selected AI model supports it, the media is also sent to the AI model for pre-filtering.
• Flexible Integration: UGC Guard can be easily integrated into your existing software solution, allowing you to leverage its capabilities without having to build everything from scratch. We offer clients for JavaScript, Dart, and Python, making it easy to integrate UGC Guard into your application regardless of the technology stack you use.
• Open Source: UGC Guard is open source, released under the AGPL 3.0 License. This means you can use, modify, and distribute the software freely, as long as you comply with the terms of the license. We encourage contributions from the community to help improve and expand the project.

Getting Started

INFO

UGC Guard is currently in early development, and we are actively working on adding new features and improving the existing ones. While we are preparing to launch our SaaS solution, you can self-host to start using UGC Guard today.

Follow our self-host configuration guide to set up UGC Guard in your environment.