{"title":"Codeunit 7763 AOAI Chat Messages, procedures","url":"https://jonas-paprotka.de/ref/codeunit/7763-aoai-chat-messages/procedures/","author":"JOP-AL","license":"Metadata from Microsoft's symbol packages. AL source MIT, Copyright (c) Microsoft Corporation. Selection and wording © 2026 JOP-AL. https://jonas-paprotka.de/licenses/","subject":"Microsoft Dynamics 365 Business Central","checked":"2026-11-20","changed":"2026-10-05","object":{"type":"codeunit","id":7763,"name":"AOAI Chat Messages","app":"System Application","versions":"23-29","url":"https://jonas-paprotka.de/ref/codeunit/7763-aoai-chat-messages/","json":"https://jonas-paprotka.de/ref/codeunit/7763-aoai-chat-messages.json"},"aspect":"procedures","total":41,"rows":[{"name":"SetPrimarySystemMessage","sig":"(SecretText)","named":"(Message: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(Message: SecretText)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddSystemMessage","sig":"(Text)","named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddUserMessage","sig":"(Text)","named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddUserMessage","sig":"(Text, Text[2048])","named":"(NewMessage: Text; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(NewMessage: Text; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddAssistantMessage","sig":"(Text)","named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(NewMessage: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"ModifyMessage","sig":"(Integer, Text, Enum AOAI Chat Roles, Text[2048])","named":"(Id: Integer; NewMessage: Text; NewRole: Enum \"AOAI Chat Roles\"; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(Id: Integer; NewMessage: Text; NewRole: Enum \"AOAI Chat Roles\"; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"DeleteMessage","sig":"(Integer)","named":"(Id: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(Id: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetHistory","sig":"()","named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetHistoryNames","sig":"()","named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetHistoryRoles","sig":"()","named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetLastMessage","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetLastRole","sig":"()","named":"()","returns":"Enum AOAI Chat Roles","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"Enum AOAI Chat Roles","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetLastName","sig":"()","named":"()","returns":"Text[2048]","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"()","returns":"Text[2048]","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetHistoryLength","sig":"(Integer)","named":"(NewLength: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(NewLength: Integer)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AssembleHistory","sig":"(var Integer, var Integer)","named":"(var SystemMessageTokenCount: Integer; var MessagesTokenCount: Integer)","returns":"JsonArray","kind":"procedure","access":"internal","obsolete":null,"range":"23-29","first":23,"last":29,"obsoleteSince":null,"spans":[{"from":23,"to":29,"named":"(var SystemMessageTokenCount: Integer; var MessagesTokenCount: Integer)","returns":"JsonArray","kind":"procedure","access":"internal","obsolete":null}]},{"name":"AddToolMessage","sig":"(Text, Text, Text)","named":"(ToolCallId: Text; FunctionName: Text; FunctionResult: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(ToolCallId: Text; FunctionName: Text; FunctionResult: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetHistoryTokenCount","sig":"()","named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"Integer","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddTool","sig":"(JsonObject)","named":"(NewTool: JsonObject)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use AddTool that takes in an AOAI Function interface.","tag":"25.0"},"range":"24-27","first":24,"last":27,"obsoleteSince":24,"spans":[{"from":24,"to":27,"named":"(NewTool: JsonObject)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use AddTool that takes in an AOAI Function interface.","tag":"25.0"}}]},{"name":"ModifyTool","sig":"(Integer, JsonObject)","named":"(Id: Integer; NewTool: JsonObject)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Deprecated with no replacement. Use DeleteFunctionTool and AddTool.","tag":"25.0"},"range":"24-27","first":24,"last":27,"obsoleteSince":24,"spans":[{"from":24,"to":27,"named":"(Id: Integer; NewTool: JsonObject)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Deprecated with no replacement. Use DeleteFunctionTool and AddTool.","tag":"25.0"}}]},{"name":"DeleteTool","sig":"(Integer)","named":"(Id: Integer)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use DeleteFunctionTool that takes in a function name instead.","tag":"25.0"},"range":"24-27","first":24,"last":27,"obsoleteSince":24,"spans":[{"from":24,"to":27,"named":"(Id: Integer)","returns":"","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use DeleteFunctionTool that takes in a function name instead.","tag":"25.0"}}]},{"name":"AddTool","sig":"(Interface AOAI Function)","named":"(Function: Interface \"AOAI Function\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(Function: Interface \"AOAI Function\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"DeleteFunctionTool","sig":"(Text)","named":"(Name: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(Name: Text)","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"ClearTools","sig":"()","named":"()","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetFunctionTool","sig":"(Text, var Interface AOAI Function)","named":"(Name: Text; var Function: Interface \"AOAI Function\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(Name: Text; var Function: Interface \"AOAI Function\")","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetFunctionTools","sig":"()","named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"List","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetTools","sig":"()","named":"()","returns":"List","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use GetFunctionTool() that takes in a function name and returns the interface.","tag":"25.0"},"range":"24-27","first":24,"last":27,"obsoleteSince":24,"spans":[{"from":24,"to":27,"named":"()","returns":"List","kind":"procedure","access":"public","obsolete":{"state":"Pending","reason":"Use GetFunctionTool() that takes in a function name and returns the interface.","tag":"25.0"}}]},{"name":"ToolsExists","sig":"()","named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"Boolean","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetAddToolsToPayload","sig":"(Boolean)","named":"(AddToolsToPayload: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(AddToolsToPayload: Boolean)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetToolChoice","sig":"(Text)","named":"(ToolChoice: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(ToolChoice: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetFunctionAsToolChoice","sig":"(Text)","named":"(FunctionName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(FunctionName: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetFunctionAsToolChoice","sig":"(Interface AOAI Function)","named":"(Function: Interface \"AOAI Function\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"(Function: Interface \"AOAI Function\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetToolChoice","sig":"()","named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"Text","kind":"procedure","access":"public","obsolete":null}]},{"name":"AssembleTools","sig":"()","named":"()","returns":"JsonArray","kind":"procedure","access":"internal","obsolete":null,"range":"24-29","first":24,"last":29,"obsoleteSince":null,"spans":[{"from":24,"to":29,"named":"()","returns":"JsonArray","kind":"procedure","access":"internal","obsolete":null}]},{"name":"AddToolCalls","sig":"(JsonArray)","named":"(ToolCalls: JsonArray)","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(ToolCalls: JsonArray)","returns":"","kind":"procedure","access":"internal","obsolete":null}]},{"name":"GetLastToolCalls","sig":"()","named":"()","returns":"JsonArray","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"()","returns":"JsonArray","kind":"procedure","access":"public","obsolete":null}]},{"name":"SetToolInvokePreference","sig":"(Enum AOAI Tool Invoke Preference)","named":"(AOAIToolInvokePreference: Enum \"AOAI Tool Invoke Preference\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"(AOAIToolInvokePreference: Enum \"AOAI Tool Invoke Preference\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"GetToolInvokePreference","sig":"()","named":"()","returns":"Enum AOAI Tool Invoke Preference","kind":"procedure","access":"public","obsolete":null,"range":"25-29","first":25,"last":29,"obsoleteSince":null,"spans":[{"from":25,"to":29,"named":"()","returns":"Enum AOAI Tool Invoke Preference","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddXPIADetectionTags","sig":"(var Text)","named":"(var Input: Text)","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"27-29","first":27,"last":29,"obsoleteSince":null,"spans":[{"from":27,"to":29,"named":"(var Input: Text)","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddUserMessage","sig":"(Codeunit AOAI User Message)","named":"(AOAIUserMessage: Codeunit \"AOAI User Message\")","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AOAIUserMessage: Codeunit \"AOAI User Message\")","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"AddUserMessage","sig":"(Codeunit AOAI User Message, Text[2048])","named":"(AOAIUserMessage: Codeunit \"AOAI User Message\"; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(AOAIUserMessage: Codeunit \"AOAI User Message\"; NewName: Text[2048])","returns":"","kind":"procedure","access":"public","obsolete":null}]},{"name":"CheckCompatibilityWithModel","sig":"(SecretText)","named":"(Deployment: SecretText)","returns":"","kind":"procedure","access":"internal","obsolete":null,"range":"28-29","first":28,"last":29,"obsoleteSince":null,"spans":[{"from":28,"to":29,"named":"(Deployment: SecretText)","returns":"","kind":"procedure","access":"internal","obsolete":null}]}]}