You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: implementer-guide/configuration/ai-settings.md
+95-17Lines changed: 95 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,64 @@ published: True
8
8
position: 50
9
9
---
10
10
11
-
# AI Overview
11
+
<style>
12
+
img[alt="An image of the providers supported by the Report Server"] {
13
+
width: 600px;
14
+
}
15
+
16
+
img[alt="An image of the Model Name, Server Endpoint, and API Key fields"] {
17
+
width: 600px;
18
+
}
12
19
13
-
Beginning with the **2025 Q3** release, we are introducing the new AI Settings to our Report Server. The AI configuration includes two panels — __AI Integration__ and __AI-Powered Report Document Insights__.
20
+
img[alt="An image of the of the message that will appear if the fields are filled in correctly"] {
21
+
width: 600px;
22
+
}
14
23
15
-
During the report preview phase, the [AI-Powered Insights](https://docs.telerik.com/reporting/interactivity/ai-powered-insights) offer an extensive suite of functionalities, including the formulation of responses, the construction of prompts, engagement with AI-generated content, and the execution of predefined instructions.
24
+
img[alt="An image of the message that will appear if the fields are filled in incorrectly"] {
25
+
width: 750px;
26
+
}
27
+
28
+
img[alt="An image of the Consent Message"] {
29
+
width: 700px;
30
+
}
31
+
32
+
img[alt="Image of the Predefined Prompts in the Report Server"] {
33
+
width: 600px;
34
+
}
35
+
36
+
img[alt="Image of the 'Allow custom prompts' checkbox"] {
37
+
width: 700px;
38
+
}
39
+
40
+
img[alt="An image of the message that will appear if the fields are filled in incorrectly"] {
41
+
width: 700px;
42
+
}
43
+
44
+
img[alt="Image of the message 'The new settings have been saved successfully' in the Report Server Configuration"] {
45
+
width: 500px;
46
+
}
47
+
48
+
img[alt="An Image of how the AI Prompt Consent Dialog Appears in the Report Server"] {
49
+
width: 900px;
50
+
}
51
+
52
+
img[alt="An Image of how the Ask AI Prompt will look with custom questions in the Report Server"] {
53
+
width: 600px;
54
+
}
55
+
56
+
img[alt="An Image of how the Ask AI Prompt will look when the output has been generated in the Report Server"] {
57
+
width: 600px;
58
+
}
59
+
</style>
60
+
61
+
62
+
# AI-Powered Features Settings
63
+
64
+
With the [**2025 Q3**](https://www.telerik.com/support/whats-new/report-server/release-history/progress-telerik-report-server-2025-q2-11-1-25-716) release, Report Server introduces its first AI-powered feature — a set of configurable AI Settings designed to enhance the reporting experience through intelligent automation. The AI configuration includes two panels — __AI Integration__ and __AI-Powered Report Document Insights__.
65
+
66
+
During the report preview phase, the [AI-Powered Insights](https://docs.telerik.com/reporting/interactivity/ai-powered-insights) feature provides a rich set of capabilities, including generating responses, building prompts, interacting with AI-generated content, and executing predefined instructions. One of the configurable options in this panel is the ability to display a consent message to end users.
67
+
68
+
> Report Server does not provide a built-in REST API or include any embedded LLMs/SLMs. To use any AI-powered feature, you must have an active subscription to a third-party LLM provider. This subscription must give you access to a valid REST API endpoint and key, which must be configured in the AI Setup panel.
16
69
17
70
18
71
@@ -26,10 +79,10 @@ The AI configuration panel is always visible in the user interface, regardless o
26
79
27
80
Depending on the state of the `Enable AI` setting:
28
81
29
-
* If `Enable AI` checkbox is unchecked, the AI configuration section will not be displayed in the Report Server
30
-
* If `Enable AI` checkbox is checked, you will be able to configure the AI by following these steps:
82
+
* If the `Enable AI` checkbox is unchecked, the AI Insights section will not be displayed in the Report Server
83
+
* If the `Enable AI` checkbox is checked, you will be able to configure the AI by following these steps:
31
84
32
-
1. Choose one of the following providers:
85
+
1. Choose one of the supported providers:
33
86
34
87
| Provider |
35
88
| ------ |
@@ -38,31 +91,43 @@ Depending on the state of the `Enable AI` setting:
38
91
|`MicrosoftExtensionsOllama`|
39
92
|`MicrosoftExtensionsOpenAI`|
40
93
41
-
94
+
42
95
43
96
1. Select a `Model Name`, specify the `Server Endpoint` and the `API Key`
44
97
45
98
46
99
47
-
> While the **Provider** and **Model** are required for all AI providers, the remaining fields(**Endpoint** and **API Key**) depend on the specific provider's requirements.
100
+
> While the **Provider** and **Model** are required for all AI providers, the remaining fields(**Endpoint** and **API Key**) depend on the specific provider's requirements.
48
101
49
-
If all required fields are filled in, you can test the integration using the `Test Integration` button. This will send a request to the selected provider with the specified information using a test prompt. If everything is configured correctly, you will receive a response saying `Integration successful`. If there is a problem, a pop-up will appear with detailed error information.
102
+
If all required fields are filled in, you can test the integration using the `Test Integration` button. This will send a request to the selected provider with the specified information using a test prompt. If everything is configured correctly, you will receive a response saying `Integration successful`.
50
103
51
-
104
+
52
105
53
-
106
+
If there is a problem, a pop-up will appear with detailed error information.
107
+
108
+
54
109
55
110
## AI-Powered Report Document Insights
56
111
57
-
From this panel, you can choose whether to display a content message by setting the `Show consent message` checkbox to true.
112
+
This section contains the options that enable you to customize the feature ["AI Insights"](https://docs.telerik.com/reporting/interactivity/ai-powered-insights) available during report preview. The customizations will be applied to both embedded and external report viewers that are connected to this Report Server instance.
113
+
114
+
### Consent Message Settings
115
+
116
+
The **Consent Message Setting** is part of the panel that allows you to configure the AI prompt displayed in the Report Viewer. It plays an important role in ensuring transparency and user awareness when interacting with AI features.
58
117
59
-
118
+
From this panel, you can choose whether to display a consent message by setting the `Show consent message` checkbox to true. When this option is activated, a predefined message will be shown to users before they interact with AI-generated content. Once users confirm their consent, the confirmation is preserved in the browser's session storage, ensuring the consent dialog won't be shown again during the same session.
60
119
61
-
> If `Show consent message` checkbox is checked, and the content message field is empty, you will not be able to save the changes.
120
+
The `Consent Message` is a notification shown to users before they interact with AI features. When enabled, the message informs users that by using the AI functionality, they agree to the processing of any data they provide—such as their prompts—for the purpose of delivering the service. It may include a link to the applicable privacy policy, helping users understand how their data will be handled. You can customize the content of the consent message to better align with your organization’s tone, legal requirements, or user expectations.
121
+
122
+
123
+
124
+
> If the `Show consent message` checkbox is checked, and the consent message field is empty, you will not be able to save the changes.
62
125
63
126
### Prompts Settings
64
127
65
-
You can create as many **Predefined Prompts** as needed. You can also delete any prompts that are no longer required. However, if there is only one Predefined Prompt, it cannot be deleted. If you would like to enable 'custom prompts' for the end-users and *not* give them any predefined prompts, leave the prompts blank and save.
128
+
The **Prompts Settings** panel allows you to configure how AI prompts are presented to end-users within the Report Viewer. This includes managing predefined prompts, enabling custom prompts, and controlling user interaction with AI-generated content.
129
+
130
+
You can create as many **Predefined Prompts** as needed. You can also delete any prompts that are no longer required.
66
131
67
132
68
133
@@ -74,15 +139,18 @@ If all settings have been configured correctly and the changes have been saved,
74
139
75
140
76
141
142
+
## Workflow
143
+
This section describes the workflow of displaying the AI prompt during report preview.
144
+
77
145
### Consent
78
146
79
147
Before any user can use this feature, upon opening the **AI Prompt Dialog**, they will be asked to give consent to the AI to process the provided text.
80
148
81
149
82
150
83
-
### Ask AI Prompt
151
+
### AI Prompt
84
152
85
-
After consent is given, the prompt for asking the AI questions will appear in the top-right corner of the report viewer. The UI will change depending on whether custom questions are allowed.
153
+
Once consent is provided, a prompt for submitting questions to the AI will appear in the top-right corner of the report viewer. The UI will change depending on whether custom questions are allowed.
86
154
87
155
88
156
@@ -91,3 +159,13 @@ After consent is given, the prompt for asking the AI questions will appear in th
91
159
The **Output** of the AI processor will be displayed in the Output tab of the Ask AI Prompt after the result has been generated:
92
160
93
161
162
+
163
+
## Differences between Report Server for .NET and Report Server for .NET Framework
164
+
165
+
In [Report Server for .NET]({%slug coming-soon%}), *Retrieval-Augmented Generation* (RAG) is enabled by default to enhance response accuracy and relevance while minimizing token usage.
166
+
167
+
Currently, RAG can be disabled only via the `appsettings.json` configuration file.
168
+
169
+
Support for controlling the RAG status directly from the UI is planned for upcoming versions of RS.NET. This feature is already logged for Q4.
170
+
171
+
> Retrieval-Augmented Generation (RAG) is not supported in Report Server for .NET Framework.
0 commit comments