[Copilot No. Series] Number series copilot #764

DmitryKatson · 2024-03-16T07:27:14Z

Summary

Introducing the first [draft] version of a "Number Series Copilot" for Business Central, an innovative feature designed to simplify the creation of number series through natural language commands. This allows users to effortlessly set up number series for specific entities like customers, vendors, or even across all entities, by simply describing their needs or specifying a format example.

Current version is intent to create number series for NEW company, where no Number Series exist yet.

Number.Series.Copilot.-.New.company.Scenario.mp4

This flow was tested on the Set up numbers series for the new company like user prompts

Please follow this diagram (green flow), to get the idea of the ongoing process.

Key ideas:

Azure OpenAI Tools calling is used to understand the user intent
AL is used to gather data from BC and build tool response
The new company flow requires about 120 different number series to be generated. Nor GPT-4, not GPT 3.5 turbo (latest) where possible to generate accurate json array with 1 go
Thus, instead of 1 LLM call to build 120 number series, the tool response is been chunked, to generate not more than 10 number series in one go
All LLM generations results (12 in total, each requires 5-9 sec of GPT 3.5 time) then been combined in 1 answer, which is presented to the user

Setup:

Use No. Series with Copilot Setup to set up Azure Open AI connection and prompts
Prompts should be provided separately (using other channels) due to security reasons
Model used: gpt-35-turbo-1106

Work Item(s)

Fixes #659
Fixes AB#503148

…ut AI implementation business logic) Added new app components and capabilities for the No. Series Copilot app, including codeunits, page extensions, pages, and tables, to introduce AI features for generating number series. Additionally, new registers and installers were included to handle capability registration and app installation. This enhances the app's functionality and extensibility.

Update page and table numbers as there was overflow with the Base Application.

- Temporary adding Number Series Copilot Setup table and page to store aoai secrets, system prompt and functions prompt in the isolated storage. - Add Jupyter Notebook patterns to gitignore. - Updating codeunit, page, and table objects numbers.

The code refactor improves tool retrieval, adds tool ID handling, and updates UI elements. The changes aim to enhance the No. Series Copilot tool functionality and user experience. These alterations are crucial for integrating Azure Key Vault in future. Include tool calls to the chat history - Add support for tool call IDs in chat history, improving traceability and accountability for tool call results. The changes enable associating tool call IDs with tool messages in the chat history, enhancing the clarity and transparency of the interactions. This update aligns with the need to provide comprehensive context for tool call responses within the chat history.

- Introduce 'AddToolMessage' method and modify existing methods to capture tool-related data for chat messages. - Add 'HistoryToolCallIds' list to save tool call IDs for messages. - Create 'IsToolsList' method to check if a message contains tool-related information. - Update 'AOAIChatRoles.Enum.al' to define a new 'tool' chat role. These changes enable the tracking and differentiation of tool call results in chat history.

Enable support for returning valid JSON object as chat completion, adding guidelines for JSON production, and checking compatibility for JSON response format.

Improve json output format specification declaration and [TEMPORARY] implement no. series number limitations to avoid reaching token limit and timeout when dealing with many tables.

Consolidates tool invocation logic by using a dedicated function and refines prompt formats for better user experience. Also updates existing patterns to reflect more accurate numbering conventions. These changes aim to streamline tool usage and enhance prompt clarity.

Consolidate tool retrieval methods; refactor output format instructions. Improved modularity and maintainability.

Add new Json module to provide tools for working with JSON data, including reading, writing, and parsing JSON. Introduces codeunit for initializing JSON array and object, retrieving element counts, fetching objects by index, and getting values for specified record fields. Implements methods to interact with JSON data using .NET types. This is partly ported from Base Application codeunit 5459 "Json management"

Additionally, the visibility of response text on the No. Series Proposal Page is dynamically managed, depending on json response validation

…e number series pattern

Tools message parsing into `function name`, `arguments` and `tool call id`

Replace direct parsing with dedicated method for improved maintainability and readability. This enhances code structure and sets the stage for future extensibility. No related issues.

…f the tool response exceeds token limit. Ensure secure handling of sensitive data in chat messages by swapping text types with secure text types. Implement chunking of tool responses to avoid exceeding token limits, resulting in improved prompt generation for new number series. Indirectly address potential security vulnerabilities and enhance system functionality.

Change the dictionary to standardize chunk processing of tables in order to avoid hallucinations and effectively handle large volumes. This ensures accurate and complete model responses, enhancing overall functionality. The refactor also introduces new helper functions to process tool completions and validate generated number series.

…nd output examples from setup Introduce methods to retrieve tool 1 patterns and output examples from setup. Also, add labels and separators for better formatting. Improve error handling and optimize code readability.

Improved retrieval of tool 1 general instructions and output format for better modularity and maintainability.

…dle duplicate No. Series codes This commit refactors JSON manipulation by separating common JSON operations into a separate file and introduces new functionality to handle duplicate No. Series codes using random character generation. This change improves data integrity and ensures uniqueness of No. Series codes. It adds methods to replace or add properties in JSON objects and modify JSON arrays as necessary.

Replace text prompts for tool limitations, code guidelines, description guidelines, number guidelines, output examples, and output format prompts. Add validation for property lengths in generating number series.

Refactor JSON handling methods to return JSON objects and arrays as text, enhancing readability and modularity across the codebase, paving the way for simplified integration with other modules. This change sets the stage for easier maintenance and future expansions of the JSON-related functionalities. No related issues are involved.

Adjusted function to correctly remove the last character in the AreasText variable to ensure proper string formatting. This change ensures accurate text representation.

JesperSchulz

We should look into the remaining TODOs and open code review comments. It's time to get this code production ready. When we think we're there, we can get one final round of review from the product group.

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesExt.PageExt.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesCopilotImpl.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopAddIntent.Codeunit.al

...usiness Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopChangeIntent.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/Tools/RecordMatchImpl.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Register/NoSeriesCopilotRegister.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Setup [DRAFT]/NoSeriesCopilotSetup.Page.al

src/Business Foundation/App/NoSeriesCopilot/src/Setup [DRAFT]/NoSeriesCopilotSetup.Table.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesCopilotImpl.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesProposal.Table.al

Adjusted No. Series handling to support 'Is Next Year' scenario and added Next Year Intent tool to facilitate setting up number series for the next year. These changes aim to improve future number series management.

…on/BCApps into Number-Series-Copilot

Update a function to handle different scenarios for generating number series prompts based on the current or next year. This change improves flexibility and customization in managing number series adjustments.

DmitryKatson · 2024-07-11T07:42:08Z

🧨 New Skill is added: Prepare for next year.
This skill (or tool) allows to create new number series lines for the next year, if number series are yearly based (have year prefix in the number).

See in the video example.

NextYearNumberSeries.mov

Removed the duplicate "Generate With Copilot" action to optimize code clarity and avoid redundancy. This action was unnecessary due to duplication with an existing action. Refactoring enhances maintainability.

...usiness Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopChangeIntent.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopAddIntent.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopGenerate.Codeunit.al

...Business Foundation/App/NoSeriesCopilot/src/Copilot/Tools/NoSeriesCopNxtYrIntent.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesProposal.Page.al

src/Business Foundation/App/NoSeriesCopilot/src/Register/NoSeriesCopilotRegister.Codeunit.al

src/Business Foundation/App/NoSeriesCopilot/src/Setup [DRAFT]/NoSeriesCopilotSetup.Table.al

src/Business Foundation/App/NoSeriesCopilot/src/Setup [DRAFT]/NoSeriesCopilotSetup.Page.al

src/Business Foundation/App/NoSeriesCopilot/src/Utilities/NoSerCopNotificManager.Codeunit.al

Simplify notification handling by integrating it directly into the main codebase, removing redundant manager code segments. This consolidation streamlines notifications within the NoSeriesCopilot system.

… shift from handling "No. Series Proposal" to "No. Series Generation" and "No. Series Proposal Line" to "No. Series Generation Detail"

…esCopilotImpl.Codeunit.al Co-authored-by: Darrick <[email protected]>

Changes made

DmitryKatson added 24 commits March 4, 2024 21:55

Changed page and table numbers

0e90f92

Update page and table numbers as there was overflow with the Base Application.

Adding tools support from AI system module

38ff86e

Add support of JSON mode

0d9569f

Enable support for returning valid JSON object as chat completion, adding guidelines for JSON production, and checking compatibility for JSON response format.

[DRAFT] Add support for json output

573e296

Improve json output format specification declaration and [TEMPORARY] implement no. series number limitations to avoid reaching token limit and timeout when dealing with many tables.

[DRAFT] Moving from GPT-4 to GPT-3.5 and refactor prompts

48395f5

Consolidate tool retrieval methods; refactor output format instructions. Improved modularity and maintainability.

[DRAFT] Show generated No. Series in the prompt dialoge

13fcfc9

Additionally, the visibility of response text on the No. Series Proposal Page is dynamically managed, depending on json response validation

Adding Area to the prompt so that copilot have better "feeling" on th…

73e5041

…e number series pattern

Tools message parsing and tool extraction logic

1cf9105

Tools message parsing into `function name`, `arguments` and `tool call id`

[DRAFT] Refactor tool parsing to utilize dedicated method

2e4f32e

Replace direct parsing with dedicated method for improved maintainability and readability. This enhances code structure and sets the stage for future extensibility. No related issues.

[DRAFT] Tool 1 prompt refactoring for better speed

a5e294b

Improved retrieval of tool 1 general instructions and output format for better modularity and maintainability.

Refactor No. Series Copilot prompts

2360e7c

Replace text prompts for tool limitations, code guidelines, description guidelines, number guidelines, output examples, and output format prompts. Add validation for property lengths in generating number series.

[DRAFT] Adding custom pattern instructions to the prompt

0aea640

Added a custom label to prompt list for user-defined number patterns.

debd0e5

DmitryKatson requested review from a team as code owners March 16, 2024 07:27

DmitryKatson requested a review from bc-ghost March 16, 2024 07:27

github-actions bot added AL: System Application AL: Business Foundation labels Mar 16, 2024

DmitryKatson and others added 3 commits July 5, 2024 16:29

Resolved [NonDebuggable] and SecretText

dfa953a

Refine logic for removing last character in AreasText

c97d811

Adjusted function to correctly remove the last character in the AreasText variable to ensure proper string formatting. This change ensures accurate text representation.

Fix CodeCop issues.

9f55606

JesperSchulz previously requested changes Jul 10, 2024

View reviewed changes

JesperSchulz reviewed Jul 10, 2024

View reviewed changes

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesCopilotImpl.Codeunit.al Outdated Show resolved Hide resolved

JesperSchulz reviewed Jul 10, 2024

View reviewed changes

src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeriesProposal.Table.al Outdated Show resolved Hide resolved

DmitryKatson added 3 commits July 10, 2024 22:03

Refactor: Enhance No. Series handling, add Next Year Intent

8f5ca9d

Adjusted No. Series handling to support 'Is Next Year' scenario and added Next Year Intent tool to facilitate setting up number series for the next year. These changes aim to improve future number series management.

Merge branch 'Number-Series-Copilot' of https://github.com/DmitryKats…

2c1a1db

…on/BCApps into Number-Series-Copilot

Refactor function to handle year-specific number series prompts

bced8ff

Update a function to handle different scenarios for generating number series prompts based on the current or next year. This change improves flexibility and customization in managing number series adjustments.

DmitryKatson added 4 commits July 11, 2024 14:45

Refactor: Remove duplicate "Generate" action on NoSeriesExt page

177ac6b

Removed the duplicate "Generate With Copilot" action to optimize code clarity and avoid redundancy. This action was unnecessary due to duplication with an existing action. Refactoring enhances maintainability.

removed todo

5290e43

Refactor code to remove TODO comments and unused code

30a5519

Removed Internal proedure

aff42ad

darjoo reviewed Jul 15, 2024

View reviewed changes

DmitryKatson and others added 11 commits July 24, 2024 16:29

Refactor notification handling and remove redundant manager code

830ae0b

Simplify notification handling by integrating it directly into the main codebase, removing redundant manager code segments. This consolidation streamlines notifications within the NoSeriesCopilot system.

Updated naming conventions in the No Series Copilot implementation to…

a98d8ba

… shift from handling "No. Series Proposal" to "No. Series Generation" and "No. Series Proposal Line" to "No. Series Generation Detail"

Update src/Business Foundation/App/NoSeriesCopilot/src/Copilot/NoSeri…

02035f2

…esCopilotImpl.Codeunit.al Co-authored-by: Darrick <[email protected]>

Fix typo in function name

ca2600a

Delete setup objects

998f1ed

Update

8f8bf7f

Add tags

a3d2dd7

Tag

9424776

Remove sleep

08e3e9b

Add inherent X permission to temp table

16d901f

tag and remove unused variables

6b13f05

darjoo approved these changes Jul 31, 2024

View reviewed changes

haoranpb approved these changes Aug 1, 2024

View reviewed changes

darjoo merged commit f71bdbd into microsoft:main Aug 1, 2024
17 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Copilot No. Series] Number series copilot #764

[Copilot No. Series] Number series copilot #764

DmitryKatson commented Mar 16, 2024 •

edited by github-actions bot

Loading

JesperSchulz left a comment

DmitryKatson commented Jul 11, 2024

[Copilot No. Series] Number series copilot #764

[Copilot No. Series] Number series copilot #764

Conversation

DmitryKatson commented Mar 16, 2024 • edited by github-actions bot Loading

Summary

Key ideas:

Setup:

Work Item(s)

JesperSchulz left a comment

Choose a reason for hiding this comment

DmitryKatson commented Jul 11, 2024

DmitryKatson commented Mar 16, 2024 •

edited by github-actions bot

Loading