Skip to content

Commit eca6ae4

Browse files
Todor rag correct (#1795)
* Update aiclient-element.md * Update AI-powered-insights.md * Update AI-powered-insights.md --------- Co-authored-by: Dimitar Nikolov <[email protected]>
1 parent bbf04ee commit eca6ae4

File tree

2 files changed

+13
-3
lines changed

2 files changed

+13
-3
lines changed

doc-output/configure-the-report-engine/aiclient-element.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ __`<AIClient>` element__
2828
| | |
2929
| ------ | ------ |
3030
|Attributes|<ul><li>__friendlyName__ - Required string attribute. Specifies the name that corresponds to the type of AI client to be used. The names of the currently supported AI client types are: `MicrosoftExtensionsAzureAIInference`, `MicrosoftExtensionsAzureOpenAI`, `MicrosoftExtensionsOllama`, and `MicrosoftExtensionsOpenAI`.</li><li>__model__ - Required string attribute. Specifies the AI model to be used for generating responses. For example, setting the model to "gpt-4o-mini" indicates that the GPT-4o mini model variant is being utilized.</li><li>__endpoint__ - Optional string attribute. If set, specifies the URL of the AI service endpoint.</li><li>__credential__ - Optional string attribute. If set, specifies the authentication credentials used to access the AI service.</li><li>__requireConsent__ - Optional boolean attribute _(true by default)_. Determines whether users must explicitly consent to the use of AI services before the AI report insights features can be utilized within the application.</li><li>__allowRAG__ - Optional boolean attribute _(true by default)_. Allows the Retrieval-Augmented Generation (RAG). The _ragSettings_ will be respected only when _allowRAG_ is _true_.</li><li>__allowCustomPrompts__ - Optional boolean attribute _(true by default)_. Determines whether users are allowed to freely communicate with the AI model. If set to false, custom queries are forbidden and only the predefined prompts can be used.</li></ul>|
31-
|Child Elements|<ul><li>__predefinedPrompts__ - Optional element. Defines a list of predefined prompts that the AI client can use.</li></ul>|
31+
|Child Elements|<ul><li>__predefinedPrompts__ - Optional element. Defines a list of predefined prompts that the AI client can use.</li><li>__ragSettings__ - Optional element. Configures the Retrieval-Augmented Generation (RAG) options.</li></ul>|
3232
|Parent Element|__Telerik.Reporting__ - Configures all settings that the Telerik Reporting Engine uses.|
3333

3434
__`<ragSettings>` element__

interactivity/AI-powered-insights.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The AI-powered insights during report preview provide comprehensive capabilities
1616

1717
## Feature Concept
1818

19-
To bring the power of Generative AI (GenAI) into reporting workflows, we are introducing a **AI Prompt** that integrates seamlessly with our [HTML5-based Report Viewers]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/html5-report-viewer/overview%}). This feature is designed to enhance productivity and user experience by enabling intelligent interactions with report content.
19+
To bring the power of Generative AI (GenAI) into reporting workflows, we are introducing a **AI Prompt** that integrates seamlessly with our [HTML5-based Report Viewers]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/web-application/html5-report-viewer/overview%}) and the [WPF Report Viewer]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/wpf-application/overview%}). This feature is designed to enhance productivity and user experience by enabling intelligent interactions with report content.
2020

2121
>note The **AI Prompt** functionality will be made available for the other [Report Viewers]({%slug telerikreporting/using-reports-in-applications/display-reports-in-applications/overview%}) as well, in the releases to come.
2222
@@ -57,6 +57,8 @@ Before using the AI Prompt Dialog, users must give consent for the AI to process
5757
|requireConsent|A boolean configuration option that determines whether users must explicitly consent to the use of AI models before the AI report insights features can be utilized within the application.|
5858
|allowCustomPrompts|This setting is set to true by default. If you set it to `false`, users will only be able to use the predefined prompts and will not be allowed to ask custom prompts.|
5959
|predefinedPrompts|This setting specifies a list of predefined prompts that the AI client can use. Each prompt is defined by a text attribute, which contains the prompt's content.|
60+
|allowRAG|This setting specifies whether the [Retrieval-Augmented Generation (RAG)](https://en.wikipedia.org/wiki/Retrieval-augmented_generation) is allowed. The default value is _true_. Available only on projects targeting .NET and .NET Standard.|
61+
|ragSettings|These settings specify the configuration of the [Retrieval-Augmented Generation (RAG)](https://en.wikipedia.org/wiki/Retrieval-augmented_generation) when allowed by the _allowRAG_ setting. Available only on projects targeting .NET and .NET Standard.|
6062

6163
__AI clients__
6264

@@ -88,10 +90,18 @@ Below is an example of how to configure the project for the `AzureOpenAI` option
8890
"credential": "...",
8991
"requireConsent": false,
9092
"allowCustomPrompts": false,
93+
"allowRAG": true,
9194
"predefinedPrompts": [
9295
{ "text": "Prompt 1" },
9396
{ "text": "Prompt 2" }
94-
]
97+
],
98+
"ragSettings": {
99+
"tokenizationEncoding": "Set Encoding Name Here",
100+
"modelMaxInputTokenLimit": 15000,
101+
"maxNumberOfEmbeddingsSent": 15,
102+
"maxTokenSizeOfSingleEmbedding": 0,
103+
"splitTables": true
104+
}
95105
}
96106
}
97107
}

0 commit comments

Comments
 (0)