Skip to content

Commit df527f8

Browse files
Merge pull request #1094 from EnterpriseDB/upm-94993
HM 2026.5 - add HM Chat Agent documentation
2 parents 84c30ed + c55254b commit df527f8

6 files changed

Lines changed: 566 additions & 0 deletions

File tree

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
---
2+
title: What the Chat Agent can do
3+
navTitle: Capabilities
4+
description: Catalog of Chat Agent capabilities in Hybrid Manager — estate browsing, Postgres Cluster lifecycle management, monitoring, recommendations, SQL, migrations, and documentation Q&A — with example prompts.
5+
deepToC: true
6+
---
7+
8+
Chat Agent helps you operate Hybrid Manager (HM) in plain language, grouped by HM area. Available capabilities depend on the configured model's strength tier — see [Model strength tiers](configure/#model-strength-tiers). All capabilities respect your HM permissions and project scope — see [Security and data handling](./security_and_data).
9+
10+
## HM documentation Q&A
11+
12+
Answer conceptual or how-to questions about HM, including model serving, Lakehouse Analytics, and migrations. Answers come from a snapshot of the official HM documentation that ships with each HM release. Chat Agent cites the pages it read. If Chat Agent can't find an answer in the bundled snapshot, it says so and points you to the official EDB Hybrid Manager documentation site, where you can check for content added after this release.
13+
14+
Try:
15+
16+
- *How does Distributed HA differ from Advanced HA?*
17+
- *What's the recommended retention setting for backups in production?*
18+
19+
## Manage estate, projects, users, and roles
20+
21+
Browse and manage the HM estate, projects, organization and project users, role assignments, and activity feeds. You can't delete users or configure identity providers with Chat Agent — use [Configuring IdPs in the HM console](../config_idp_hm) for IdP setup.
22+
23+
Try:
24+
25+
- *Show me my projects.*
26+
- *Add `alice@example.com` to `marketing-sandbox` as a Project Editor.*
27+
28+
## Postgres cluster lifecycle management
29+
30+
List, inspect, create, delete, and restore Postgres clusters in any HM-supported topology: single node, primary/standby HA, advanced HA (AHA), distributed HA (DHA), and Lakehouse. Restore supports point-in-time recovery (PITR) and targeted-database restore. Chat Agent inspects backups and lists supported Postgres image versions. Long-running actions run as background tasks — Chat Agent returns a task reference and can check progress.
31+
32+
Try:
33+
34+
- *Create a Single Node Postgres 17 cluster in `marketing-sandbox`, location `aws-eu-west-1`, 4 vCPU, 16 GB memory.*
35+
- *Restore `customers-prod` to 12:00 UTC yesterday into a new cluster called `customers-restored`.*
36+
37+
## Cluster monitoring, alerts, and observability
38+
39+
Get current or historical values of standard cluster metrics. Available metrics cover CPU, memory, storage, I/O, throughput, network, connections, transactions, query rate and latency, buffer cache hit ratio, top databases, write-ahead logs, and checkpoints. Render metrics over time as charts. View active alerts per cluster or per project. Chat Agent mirrors the **Cluster Monitoring** page in the HM console. It doesn't create or modify dashboards, acknowledge alerts, or silence alerts — use the HM console for those.
40+
41+
Try:
42+
43+
- *Plot CPU usage on `customers-prod` over the past 24 hours.*
44+
- *Compare query latency on `orders-prod` between yesterday and today.*
45+
46+
## Recommendations and advisories
47+
48+
Get configuration, indexing, statistics, and security recommendations for a cluster, plus aggregated health scores across a project. Apply an index recommendation directly — Chat Agent asks for confirmation, then runs the work as a background task.
49+
50+
Try:
51+
52+
- *Are there any pending index recommendations on `orders-prod`?*
53+
- *Apply the recommended index on `orders.line_items.customer_id`.*
54+
55+
## Cluster health reports
56+
57+
List, fetch, analyze, and compare cluster health reports. HM generates one report per cluster per day — newly created clusters have no reports for the day of creation.
58+
59+
Try:
60+
61+
- *Compare yesterday's and today's health reports for `customers-prod` and tell me what changed.*
62+
63+
## Schema design recommendations
64+
65+
Get table-level recommendations for data types, normalization, indexing, partitioning, and constraints. Chat Agent reads the table's structure and the top queries running against it (last 6 hours by default, configurable in the question), then applies a Postgres and EDB best-practices catalog. With no workload in the window, recommendations fall back to schema-only fixes from the table definition.
66+
67+
Try:
68+
69+
- *Suggest schema improvements for table `public.orders` on `customers-prod`, database `app`.*
70+
71+
## Manage Lakehouse analytics catalogs
72+
73+
List, inspect, create, update, and delete Iceberg catalogs.
74+
75+
Try:
76+
77+
- *List the Iceberg catalogs in project `analytics-shared`.*
78+
79+
## Data Migration Service (read-only)
80+
81+
View existing migrations, sources, destinations, table mappings, error history, and assessment reports. To start, pause, resume, or delete migrations, use the HM console — Chat Agent points you to the right page.
82+
83+
Try:
84+
85+
- *Show me the failing migrations in project `migrations-prod` and the most recent error for each.*
86+
87+
## Oracle-to-Postgres SQL translation
88+
89+
Translate Oracle SQL to EDB Postgres-compatible SQL. Useful when preparing queries or schema definitions ahead of a migration from Oracle.
90+
91+
Try:
92+
93+
- *Translate this Oracle SQL: `SELECT NVL(name, 'unknown') FROM customers …`*
94+
95+
## General constraints
96+
97+
These rules apply to every capability:
98+
99+
- **HM-only scope.** Off-topic questions (general knowledge, math, other products) are out of scope.
100+
- **Confirmation gates.** Create, update, delete, drop, DDL, and DML operations require an explicit *yes* before execution.
101+
- **Permission-honest.** On a permission-denied error, Chat Agent stops and reports the error rather than retrying or routing around it.
102+
- **Status comes from a status check.** Listing a resource doesn't imply it's healthy or active — Chat Agent calls a status endpoint when needed.
103+
104+
For the security model behind these guarantees, see [Security and data handling](./security_and_data).
105+
106+
## See also
107+
108+
- [Configure the Chat Agent](./configure) — model configuration, supported providers, and tier selection.
109+
- [Security and data handling](./security_and_data) — the authorization model, audit, and data handling behind these capabilities.
110+
- [Troubleshooting](./troubleshooting) — common issues and how to resolve them.

0 commit comments

Comments
 (0)