Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- Ensure SEO is done well
- Ensure that the design theme is consistent
- Ensure that page load is opitimized so that pages load very fast

- Ensure every Markdown/MDX docs page under `src/content/docs` has a concise frontmatter `description`, since `llms.txt` uses it for page summaries.
26 changes: 26 additions & 0 deletions public/robots.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# As a condition of accessing this website, you agree to abide by the following
# content signals:
# (a) If a content-signal = yes, you may collect content for the corresponding
# use.
# (b) If a content-signal = no, you may not collect content for the
# corresponding use.
# (c) If the website operator does not include a content signal for a
# corresponding use, the website operator neither grants nor restricts
# permission via content signal with respect to the corresponding use.
# The content signals and their meanings are:
# search: building a search index and providing search results (e.g., returning
# hyperlinks and short excerpts from your website's contents). Search does not
# include providing AI-generated search summaries.
# ai-input: inputting content into one or more AI models (e.g., retrieval
# augmented generation, grounding, or other real-time taking of content for
# generative AI search answers).
# ai-train: training or fine-tuning AI models.
# ANY RESTRICTIONS EXPRESSED VIA CONTENT SIGNALS ARE EXPRESS RESERVATIONS OF
# RIGHTS UNDER ARTICLE 4 OF THE EUROPEAN UNION DIRECTIVE 2019/790 ON COPYRIGHT
# AND RELATED RIGHTS IN THE DIGITAL SINGLE MARKET.

User-agent: *
Content-Signal: search=yes, ai-input=yes, ai-train=no
Allow: /

Sitemap: https://docs.genguardx.ai/sitemap.xml
1 change: 1 addition & 0 deletions src/content/docs/deploy-and-monitor/annotation-queues.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Annotation Queues"
description: "Use GGX Annotation Queues to bring human review into production monitoring, label live data, track ground truth, and turn reviewer feedback into auditable metrics."
---

It is important to add a Human element when monitoring activity in Production as not all trends can be caught in an automated way. New trends are not always caught using programmatic approaches, but programmatic approaches are useful for repetitive tasks. Bringing a balance of both evaluation methods is key to maintaining a good healthy production system.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "CICD & Direct to Production"
description: "Export approved GGX artifacts into production runtimes, APIs, containers, serverless services, or CI/CD systems without requiring GGX in the production environment."
---

Typically, production execution environments are kept separate and managed to ensure 100% uptime as these are mission-critical systems for organizations.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/deploy-and-monitor/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Deployment and Monitoring"
description: "Deploy approved GGX pipeline artifacts to production and monitor reliability, performance, accuracy, alerts, and human annotation queues for live GenAI systems."
---

Once a pipeline is registered on the GGX platform, it can be [evaluated and approved](../evaluate-and-approve/) within the system. After approval, the locked pipeline artifact can be [exported directly to production](direct-to-production/).
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/deploy-and-monitor/oversight.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Governance Oversight"
description: "Monitor GGX governance activity with dashboards, object views, custom alerts, role-based views, and review signals across registered models, prompts, RAGs, and pipelines."
---

The Monitoring Dashboard provides users with a comprehensive overview of all registered objects on the platform which helps in providing a clear Oversight of all activities happening. It offers an interface that enables users to access snapshots and trend statistics related to various objects, jobs, and users. The dashboard provides various metadata information such as properties, attributes, and statuses of the registered objects.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/deploy-and-monitor/performance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Performance Tracking"
description: "Track approved GGX object performance with recurring jobs, metrics dashboards, thresholds, alerts, and data views that surface production and evaluation trends."
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Approval Workflows"
description: "Create GGX approval workflows with responsibilities, reviewers, review actions, comments, notifications, and audit trails for governed GenAI release decisions."
---

<helper-panel object='ApprovalWorkflow' location='list'>
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/evaluate-and-approve/comparison.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Comparisons"
description: "Compare GGX objects against challengers using shared datasets, selected metrics, automated reports, and side-by-side results for model and pipeline evaluation."
---

Platform provides the ability to compare the registered objects for a specific task using standard and customized metrics. Using this comparison capability one can quickly evaluate a list of candidates to select the best one.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Document Generation"
description: "Generate governance and approval documentation from GGX evaluation results, metadata, reports, object details, and review evidence for downstream stakeholders."
---

As GGX starts to understand the kind of pipeline being created, what models, prompts, etc. it is using and also starts to understand the evaluations being run on the pipeline. It becomes a great central knowledge base of all work done throughout the GenAI lifecycle.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Feedback Portals"
description: "Create GGX Feedback Portals that let testers and domain experts interact with pipelines, define expected outputs, collect session feedback, and review structured quality signals."
---

The Feedback Portal is a platform feature designed to help teams evaluate, test, and improve AI pipelines by collecting structured feedback from domain experts and testers. It bridges the gap between raw pipeline outputs and real-world quality assessment by letting subject matter experts interact with a pipeline directly and provide detailed evaluations of every session.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/evaluate-and-approve/human-testing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Human Integrated Testing"
description: "Run human-integrated GGX tests where reviewers evaluate pipeline behavior, capture qualitative feedback, validate outcomes, and support approval decisions."
---

The Human Integrated Testing module enables comprehensive testing of GenAI pipelines both before approval (Pre-Approval) and after deployment (Post-Approval/Post-Deployment), involving humans in the loop.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/evaluate-and-approve/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Evaluations and Approval"
description: "Evaluate GGX pipelines and components with automated jobs, human annotations, standardized reports, comparison workflows, and structured approval processes before production release."
---

## Purpose of Evaluations
Expand Down
90 changes: 90 additions & 0 deletions src/content/docs/evaluate-and-approve/reporting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,96 @@ The Parameter Schema lists the **inputs a user supplies at run time** — thresh
| `selectbox` | Dropdown | One choice from a longer list (`options`). |
| `selectbutton` | Button group | One choice from a short set of `options`. |

The following examples show common parameter schema patterns you can adapt for reports.

<details class="ggx-details">
<summary>Prompt inputs</summary>

Two common report parameters for collecting user input before generating a report.

```json
[
{
"key": "department",
"type": "selectbox",
"label": "Department",
"placeholder": "Choose a department",
"options": [
"Sales",
"Support",
"Finance"
],
"required": true
},
{
"key": "reporting_period",
"type": "textbox",
"label": "Reporting period",
"placeholder": "e.g. 2026-Q2",
"required": true
}
]
```

</details>

<details class="ggx-details">
<summary>Numeric threshold</summary>

A numeric parameter for reports that need a score cutoff, confidence floor, or pass/fail boundary.

```json
[
{
"key": "minimum_confidence",
"type": "numberbox",
"label": "Minimum confidence",
"placeholder": "0.8",
"description": "Rows below this confidence score are flagged for review.",
"defaultValue": "0.8",
"required": true
}
]
```

</details>

<details class="ggx-details">
<summary>Choice controls</summary>

Use `selectbox` for a longer list and `selectbutton` when the user should pick from a short, visible set of options.

```json
[
{
"key": "risk_category",
"type": "selectbox",
"label": "Risk category",
"placeholder": "Choose a risk category",
"options": [
"Accuracy",
"Bias",
"Toxicity",
"Security"
],
"required": true
},
{
"key": "review_mode",
"type": "selectbutton",
"label": "Review mode",
"defaultValue": "Summary",
"options": [
"Summary",
"Detailed"
],
"required": true
}
]
```

</details>

For example, a single pass/fail threshold:

```json
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/evaluate-and-approve/simulation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Simulation"
description: "Run GGX simulation jobs on datasets to evaluate objects, generate reports, inspect metrics, validate evaluators, and compare results before approval."
---

The most common type of execution is a **Simulation** - used to execute analytics contained in the definition of an object that has been registered in the platform. And additionally, run dashboards and reports on that output.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Cleanlab"
description: "Connect Cleanlab with GGX to use external data quality and evaluation signals in model, RAG, pipeline, and dataset assessment workflows."
---

![alt text](cleanlab_logo.png)
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "GGX Integrations"
description: "Connect GGX with LLM providers, LLM gateways, observability tools, agent frameworks, report providers, voice providers, and SSO systems across the AI lifecycle."
---

GGX is built with extensibility in mind and supports a wide range of integrations that allow you to seamlessly plug into existing workflows and tools.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/anthropic.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Anthropic Integration"
description: "Configure Anthropic in GGX and register Claude-backed models with provider credentials, model arguments, scoring logic, and governed model metadata."
---

The Anthropic integration provides access to Claude models through a unified interface. Configure once, use everywhere with enterprise-grade safety features and constitutional AI principles built into every interaction.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/aws-bedrock.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "AWS Bedrock Integration"
description: "Configure AWS Bedrock in GGX and register Bedrock-backed foundation models with AWS credentials, provider settings, model arguments, and scoring logic."
---

The AWS Bedrock integration provides access to foundation models from multiple AI providers through a unified interface. Configure once, use everywhere with enterprise-grade security, scalability, and comprehensive model selection from leading AI companies.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/azureai.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Azure AI Integration"
description: "Configure Azure AI in GGX and register Azure-hosted OpenAI models with API credentials, model provider settings, arguments, and scoring logic."
---

The Azure AI integration provides access to OpenAI models hosted on Microsoft Azure through a unified interface. Configure once, use everywhere with enterprise-grade security and compliance.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Google Cloud Vertex AI Integration"
description: "Configure Google Cloud Vertex AI in GGX and register Gemini models with service credentials, provider settings, input arguments, and scoring logic."
---

The Google Cloud Vertex AI integration provides access to Gemini models and AI agents through a unified interface. Configure once, use everywhere with enterprise-grade security and scalability.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/huggingface.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Hugging Face Integration"
description: "Register Hugging Face models in GGX using Hub models, optional tokens, model metadata, input arguments, and custom Python scoring logic."
---

The Hugging Face integration provides direct access to thousands of open-source models from the Hugging Face Hub through a unified interface. Load once, cache efficiently, and use enterprise-grade model management with full governance and tracking.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Setting up Integrations"
description: "Configure LLM provider integrations in GGX by adding API keys, testing connections, and exposing secure environment variables for model registration and model code."
---

Setup integrations to services that provide LLMs as an API. Configure your API keys once to access multiple AI providers across the platform.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/integrations/llm-providers/openai.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "OpenAI Integration"
description: "Configure OpenAI in GGX and register OpenAI-backed models with API credentials, model settings, arguments, and governed scoring logic."
---

The OpenAI integration provides direct access to OpenAI models through a unified interface. Configure once, use everywhere with enterprise-grade performance and the latest AI capabilities from OpenAI.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Pipeline Registration Guide"
description: "Register an intent classification pipeline in GGX by connecting a model and prompt, configuring pipeline metadata, adding resources, and testing outputs."
---

A pipeline combines multiple resources (models, prompts, RAGs, helper functions) to create an end-to-end use-case specific workflow. Read more about [Pipelines](../../../inventory-management/pipelines/) to understand more about what they are and how they work. This guide covers how to register pipelines on the GGX, using an **Intent Classification Pipeline** as a working example.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Prompt Registration Guide"
description: "Register an intent classification prompt in GGX by defining prompt metadata, template variables, structured instructions, examples, and test cases."
---

This guide covers how to register prompts on the GGX, using an **Intent Classification Prompt** as a working example.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Pipeline Registration Guide: English to French Translation"
description: "Register an English-to-French translation pipeline in GGX using Gemini 2.0 Flash, custom translation logic, pipeline metadata, and usage tracking."
---

This guide walks you through registering an **English to French Translation Pipeline** on the GGX. This pipeline automatically detects English text and provides high-quality French translations using Gemini 2.0 Flash.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/register-and-refine/examples/model.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Model Registration: Gemini 2.0 Flash"
description: "Register Gemini 2.0 Flash in the GGX Model Catalog with provider settings, input arguments, scoring logic, model metadata, and test examples."
---

This guide covers registering the Gemini 2.0 Flash model on the platform.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/register-and-refine/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "GenerativeAI Lifecycle Management"
description: "Use GGX to manage the GenAI lifecycle from use case definition and data collection through pipeline development, evaluation, approval, deployment, and production monitoring."
---

## Generative AI Lifecycle:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Inventory Management"
description: "Register, organize, govern, share, version, and monitor GGX data and GenAI assets including tables, models, prompts, RAGs, and end-to-end pipelines."
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Data Assets"
description: "Register data tables and quality checks in GGX so teams can track source data, fetch schemas, run data quality reports, audit changes, and reuse validation datasets."
---

<helper-panel object='DataTable' location='list'>
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/register-and-refine/lineage-tracking.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Lineage Tracking"
description: "Use GGX lineage tracking to visualize object dependencies, identify upstream and downstream impact, support traceability, and understand how registered assets are used."
---

Lineage tracking records and visualizes the complete lifecycle of an object and depicts the flow of execution, showing how objects interact, are transformed and executed. It captures its origins, building blocks used, transformations, and usages across the organization.
Expand Down
1 change: 1 addition & 0 deletions src/content/docs/register-and-refine/sync.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "GGX Sync"
description: "Use GGX Sync to declare, version, and synchronize prompts, models, RAGs, pipelines, global functions, and reports from Python code into GenGuardX."
---

## Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "CI CD Integrations"
description: "Integrate GGX approval workflows with external CI/CD and review systems by implementing custom approval handlers and exchanging review actions through APIs."
---

There are scenarios when approval of an object is not confined to the reviewers registered on the platform.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Common Configs"
description: "Configure common self-hosted GGX settings for application services, API behavior, storage, authentication, workers, notebooks, logging, and deployment environments."
---

After the installation, there are some configurations that need to be configured for each of the
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Metadata: Database Setup"
description: "Configure GGX metadata database connections for PostgreSQL, Oracle, SQL Server, and related self-hosted database settings, migrations, and operational requirements."
---

This section describes the different database options available for the Metadata Database. Choosing
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Datalake Integration"
description: "Configure GGX data lake access for self-hosted deployments so jobs, reports, and analytics can read and write approved data locations."
---

GGX provides the ability to connect to different kinds of data lakes which could have data saved as `parquet`, `orc`,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Email Notifications"
description: "Configure email notification settings for self-hosted GGX so approvals, alerts, reviews, and system events can reach the right users."
---

GGX provides an option to send email notifications to the user on their registered email id when
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Additional Libraries"
description: "Install and manage additional Python libraries for self-hosted GGX components, notebooks, workers, and analytical workloads."
---

GGX provides an option to allow the users to be able to use additional libraries which are not available
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "Process Management"
description: "Run self-hosted GGX services under process managers such as systemd or Supervisor to manage startup, restarts, logs, and long-running components."
---

For ease of maintenance and monitoring, it is recommended to use a process management tool to ensure
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: "SAML"
description: "Configure SAML single sign-on for self-hosted GGX with enterprise identity providers, authentication settings, and user access requirements."
---

While an internal authentication is available for simple and quick installations. It is recommended to use an enterprise-grade Identity Provider (IDP) to follow the infosec requirements for your organization. GGX can integrate into IDPs and seamlessly be a tool in your organization.
Expand Down
Loading