Skip to content

Created AI-powered-insights.md #1679

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 41 commits into from
Closed

Conversation

IvetNikolova
Copy link
Contributor

No description provided.

@IvetNikolova IvetNikolova requested a review from mzanev May 8, 2025 15:17
Copy link
Contributor

@mzanev mzanev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something I forgot to mention earlier: In the configuration section we can probably refer to the "AIClient Element" article for most of the setup but we need to mention that users also need to install one of our NuGet packages depending on the client type of their choosing. I.e. 'Telerik.Reporting.AI.Microsoft.Extensions.AzureAIInference', 'Telerik.Reporting.AI.Microsoft.Extensions.AzureOpenAI', 'Telerik.Reporting.AI.Microsoft.Extensions.Ollama', or 'Telerik.Reporting.AI.Microsoft.Extensions.OpenAI'.

@mzanev mzanev self-requested a review May 9, 2025 16:00
@petar-i-todorov petar-i-todorov requested a review from Copilot May 19, 2025 13:12
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds two new documentation pages for configuring AI-powered insights in the Telerik Report Preview and the AIClient element.

  • Introduces AI-powered insights guide detailing prompt UI, configuration settings, and extensibility.
  • Adds AIClient element reference with attributes, child elements, and examples for XML/JSON configuration.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
interactivity/AI-powered-insights.md New overview and configuration guide for AI-powered insights
doc-output/configure-the-report-engine/aiclient-element.md New reference for the <AIClient> element configuration
Comments suppressed due to low confidence (2)

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

  • The default for allowCustomPrompts is documented as false in AI-powered-insights.md but true here; please align these defaults to maintain consistency.
|__allowCustomPrompts__ - Optional boolean attribute _(true by default)_. Determines whether users are allowed to freely communicate with the AI model. If the switch is set to false, custom queries are forbidden and only the predefined prompts can be used.|

interactivity/AI-powered-insights.md:6

  • Remove the trailing comma after "ai" in the tags list to avoid potential YAML parsing issues.
tags: telerik, reporting, ai,

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds detailed documentation for AI-powered insights in report previews and the AIClient configuration element.

  • Introduces AI-Powered Insights guide with configuration examples for JSON/XML/C#
  • Adds AIClient Element reference with attributes, child elements, and sample configurations

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File Description
interactivity/AI-powered-insights.md New guide covering AI insights UI, client settings, and extensibility examples
doc-output/configure-the-report-engine/aiclient-element.md New reference page for the <AIClient> configuration element with usage examples
Comments suppressed due to low confidence (2)

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

  • This states allowCustomPrompts defaults to true, which conflicts with other docs indicating false by default. Please unify the default value.
|__allowCustomPrompts__ - Optional boolean attribute _(true by default)_|...

interactivity/AI-powered-insights.md:49

  • The closing backtick is replaced by an apostrophe here; change the trailing ' to a backtick to fix the markdown formatting.
- `Telerik.Reporting.AI.Microsoft.Extensions.OpenAI'`

Copy link
Contributor

@DimitarNikolovv06 DimitarNikolovv06 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds two new documentation pages to explain AI-powered insights and the AIClient element configuration for Telerik Reporting.

  • Introduces AI-Powered Insights guide in the interactivity section
  • Adds AIClient Element reference in the report engine configuration section

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
interactivity/AI-powered-insights.md New guide on configuring and using AI-powered insights in report previews
doc-output/configure-the-report-engine/aiclient-element.md New reference for the <AIClient> element and its attributes in configuration files
Comments suppressed due to low confidence (1)

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

  • The default value here is documented as true, but the AI-powered insights guide states the default is false. Please confirm the actual default and align both pages accordingly.
|__allowCustomPrompts__ - Optional boolean attribute _(true by default)_|

@DimitarNikolovv06 DimitarNikolovv06 requested review from Copilot and DimitarNikolovv06 and removed request for Copilot May 20, 2025 07:06
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request adds new documentation files to guide developers on configuring AI-powered insights for report previews and setting up the AIClient element.

  • Introduces the "AI-Powered Insights in Report Preview" markdown file with configuration examples in JSON, XML, and C#.
  • Adds a comprehensive "AIClient Element" configuration guide with detailed attribute descriptions and examples for both XML and JSON formats.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
interactivity/AI-powered-insights.md New documentation outlining the AI-powered insights features and configuration examples.
doc-output/configure-the-report-engine/aiclient-element.md Detailed documentation for configuring the AIClient element including attributes and usage examples.
Comments suppressed due to low confidence (1)

interactivity/AI-powered-insights.md:40

  • [nitpick] Consider revising the friendly name mapping in this table entry. The use of '+' within the client type may cause confusion; aligning the naming style with the other entries could improve clarity.
|Microsoft.Extensions.AI.OpenAI + Azure.AI.OpenAI|"MicrosoftExtensionsAzureOpenAI"|

Copy link
Contributor

@DimitarNikolovv06 DimitarNikolovv06 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@DimitarNikolovv06 DimitarNikolovv06 requested a review from Copilot May 20, 2025 07:08
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds two new documentation pages covering AI-powered insights and the AIClient configuration element for Telerik Reporting.

  • Introduces an “AI-Powered Insights” guide showing how to enable and use AI prompts in the report preview UI
  • Provides a detailed reference for the <AIClient> element (XML/JSON) with attribute definitions and examples

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File Description
interactivity/AI-powered-insights.md New guide on setting up and using AI-powered prompts in reports
doc-output/configure-the-report-engine/aiclient-element.md Reference doc for the AIClient element’s attributes and usage

Copy link
Collaborator

@todorarabadzhiev todorarabadzhiev left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@petar-i-todorov petar-i-todorov dismissed stale reviews from todorarabadzhiev, DimitarNikolovv06, and themself via b2c0472 May 20, 2025 07:48
@petar-i-todorov
Copy link
Contributor

Merge is blocked due to changes requested by Momchi. Since he's off and we need to merge the changes for the release, I am closing this PR and opening a new one using the same branch.

@DimitarNikolovv06 DimitarNikolovv06 deleted the IN-AI-powered-insights branch May 20, 2025 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants