mirror of
https://github.com/pgadmin-org/pgadmin4.git
synced 2026-08-17 16:34:44 -05:00
docs: describe what AI features transmit to LLM providers (#10291)
The AI documentation covered how to configure each provider but said nothing about what actually leaves the server once one is configured, which is the first question anyone working under data residency or procurement constraints will ask. This adds a provider-neutral section to the AI Reports documentation setting out what may be transmitted, which is schema definitions, configuration settings read from pg_settings, query text, EXPLAIN plan output and, because the Query Tool assistant can run read-only queries, row data where the assistant judges it necessary; when nothing is transmitted at all, which is the default, since no provider is configured out of the box; and the fact that each provider processes that data under its own terms and in locations of its own choosing, so the reader knows to check both those terms and their own organisation's policies before enabling a cloud provider. It also makes explicit that the list of providers reflects the APIs pgAdmin can speak to rather than a recommendation, and cross-references the new section from the AI Assistant notes in the Query Tool documentation.
This commit is contained in:
@@ -82,6 +82,38 @@ Select your preferred LLM provider from the dropdown:
|
||||
After configuring your provider, click *Save* to apply the changes.
|
||||
|
||||
|
||||
.. _ai_data_handling:
|
||||
|
||||
Data Handling and Provider Selection
|
||||
************************************
|
||||
|
||||
When a cloud LLM provider is configured, pgAdmin transmits information about
|
||||
your database to that provider's API. Depending on the feature in use, this may
|
||||
include schema definitions such as table, column, index and constraint names
|
||||
and data types; server and database configuration settings read from
|
||||
``pg_settings``; query text; and EXPLAIN plan output. The *AI Assistant* in the
|
||||
Query Tool is also able to run queries against your database, within a read-only
|
||||
transaction and limited to 1000 rows, so row data may be included where the
|
||||
assistant determines it is needed to answer a question.
|
||||
|
||||
None of this is transmitted unless you invoke an AI feature, and none of it is
|
||||
transmitted at all when no provider has been configured, which is the default;
|
||||
when AI features have been disabled by the administrator through the
|
||||
``LLM_ENABLED`` setting; or when a locally hosted provider such as Ollama or
|
||||
Docker Model Runner is configured.
|
||||
|
||||
Each provider processes this data under its own terms of service, privacy policy
|
||||
and legal jurisdiction, and operates its infrastructure in locations of its own
|
||||
choosing. If you work in an environment subject to data residency requirements,
|
||||
procurement policies, or sector-specific rules governing the handling of
|
||||
database metadata, review both the provider's terms and your own organisation's
|
||||
policies before enabling a cloud provider.
|
||||
|
||||
The providers listed in pgAdmin reflect the APIs that pgAdmin is able to
|
||||
communicate with. Their inclusion is not a recommendation, and no provider is
|
||||
enabled by default.
|
||||
|
||||
|
||||
Security Reports
|
||||
****************
|
||||
|
||||
|
||||
@@ -243,7 +243,9 @@ iteratively. For example, you can ask for a query and then follow up with
|
||||
|
||||
**Note:** The AI Assistant uses database schema inspection tools to understand
|
||||
your database structure. It supports SELECT, INSERT, UPDATE, DELETE, and DDL
|
||||
statements. All generated queries should be reviewed before execution.
|
||||
statements. All generated queries should be reviewed before execution. See
|
||||
:ref:`ai_data_handling` for details of the information that is transmitted to
|
||||
your configured LLM provider.
|
||||
|
||||
The Data Output Panel
|
||||
*********************
|
||||
|
||||
Reference in New Issue
Block a user