Chat and text-enhancement flow

Understand the OpenAI chat message roles

Review the exact messages sent by the provider.

Audience: CRM administrators and authorised staffPermission: Technical administratorModule v1.0.0

Exact navigationCode-backed reference → OpenAiProvider::chat

Before you begin

Use an account with Technical administrator and confirm the intended record or setting before making a change.
Follow the exact route above. If the screen or action is absent, check module activation, ownership and permissions rather than using another person’s account.
Use controlled test data for configuration, integration, email, AI, payment, portal or automation changes before production-wide use.

What this guide covers

Review the exact messages sent by the provider. The instructions reflect the supplied module’s registered menus, controller actions, views, settings and code-backed validation flow.

Exact step-by-step process

Open Code-backed reference → OpenAiProvider::chat.
Select the relevant record, filter, report, model or configuration described below.
Use the displayed action or read the current values without altering unrelated data.
Compare the output with the code-backed rules and expected result in this guide.
Record or correct any mismatch before relying on the output in production.

Fields, choices and supported possibilities

Developer messageThe current ai_system_prompt.

User messageThe prompt supplied by the host CRM AI feature.

Code-backed validations and workflow rules

The normal chat request contains one developer message followed by one user message.

Expected result and verification

The supported understand the openai chat message roles flow completes without bypassing permission or validation checks.
The resulting record, setting, status, file, delivery event or external response is visible from the relevant workspace.
Unexpected validation, provider or linked-record errors are investigated before retrying.

Security, privacy and operational checks

Restrict the API key and AI settings to authorised administrators.
Do not submit confidential, special-category or unnecessary personal data to the external AI provider.
Review generated text before using it in customer, staff, legal, financial or compliance communication.
Monitor provider billing and retention independently because this module has no built-in cost dashboard.