fix setting up of functions dependent on caller object

amakropoulos · amakropoulos · commit 84efdf732da3 · 2025-12-02T16:53:06.000+02:00
diff --git a/Runtime/LLMAgent.cs b/Runtime/LLMAgent.cs
@@ -139,9 +139,9 @@ public override void Awake()
             base.Awake();
         }
 
-        protected override async Task SetupLLMClient()
+        protected override async Task SetupCallerObject()
         {
-            await base.SetupLLMClient();
+            await base.SetupCallerObject();
 
             string exceptionMessage = "";
             try
@@ -158,7 +158,14 @@ protected override async Task SetupLLMClient()
                 if (exceptionMessage != "") error += ", error: " + exceptionMessage;
                 LLMUnitySetup.LogError(error, true);
             }
+        }
 
+        /// <summary>
+        /// Initialisation after setting up the LLM client (local or remote).
+        /// </summary>
+        protected override async Task PostSetupCallerObject()
+        {
+            await base.PostSetupCallerObject();
             if (slot != -1) llmAgent.SlotId = slot;
             await InitHistory();
         }
@@ -217,7 +224,7 @@ public virtual string GetSavePath()
         /// </summary>
         public virtual async Task ClearHistory()
         {
-            await CheckLLMClient(checkConnection: false);
+            await CheckCaller(checkConnection: false);
             llmAgent.ClearHistory();
         }
 
@@ -228,7 +235,7 @@ public virtual async Task ClearHistory()
         /// <param name="content">Message content</param>
         public virtual async Task AddMessage(string role, string content)
         {
-            await CheckLLMClient();
+            await CheckCaller();
             llmAgent.AddMessage(role, content);
         }
 
@@ -238,7 +245,7 @@ public virtual async Task AddMessage(string role, string content)
         /// <param name="content">User message content</param>
         public virtual async Task AddUserMessage(string content)
         {
-            await CheckLLMClient();
+            await CheckCaller();
             llmAgent.AddUserMessage(content);
         }
 
@@ -248,7 +255,7 @@ public virtual async Task AddUserMessage(string content)
         /// <param name="content">Assistant message content</param>
         public virtual async Task AddAssistantMessage(string content)
         {
-            await CheckLLMClient();
+            await CheckCaller();
             llmAgent.AddAssistantMessage(content);
         }
 
@@ -275,7 +282,7 @@ public class CompletionResponseJson
         public virtual async Task<string> Chat(string query, LlamaLib.CharArrayCallback callback = null,
             EmptyCallback completionCallback = null, bool addToHistory = true)
         {
-            await CheckLLMClient();
+            await CheckCaller();
 
             // Wrap callback to ensure it runs on the main thread
             LlamaLib.CharArrayCallback wrappedCallback = Utils.WrapCallbackForAsync(callback, this);
@@ -341,7 +348,7 @@ public virtual async Task SaveHistory()
                 LLMUnitySetup.LogError("No save path specified");
                 return;
             }
-            await CheckLLMClient();
+            await CheckCaller();
 
             // Save chat history
             string jsonPath = GetSavePath();
@@ -373,7 +380,7 @@ public virtual async Task LoadHistory()
                 LLMUnitySetup.LogError("No save path specified");
                 return;
             }
-            await CheckLLMClient();
+            await CheckCaller();
 
             // Load chat history
             string jsonPath = GetSavePath();
diff --git a/Runtime/LLMClient.cs b/Runtime/LLMClient.cs
@@ -132,7 +132,7 @@ public bool remote
                 if (_remote != value)
                 {
                     _remote = value;
-                    if (started) _ = SetupLLMClient();
+                    if (started) _ = SetupCaller();
                 }
             }
         }
@@ -153,7 +153,7 @@ public string APIKey
                 if (_APIKey != value)
                 {
                     _APIKey = value;
-                    if (started) _ = SetupLLMClient();
+                    if (started) _ = SetupCaller();
                 }
             }
         }
@@ -167,7 +167,7 @@ public string host
                 if (_host != value)
                 {
                     _host = value;
-                    if (started) _ = SetupLLMClient();
+                    if (started) _ = SetupCaller();
                 }
             }
         }
@@ -181,7 +181,7 @@ public int port
                 if (_port != value)
                 {
                     _port = value;
-                    if (started) _ = SetupLLMClient();
+                    if (started) _ = SetupCaller();
                 }
             }
         }
@@ -223,7 +223,7 @@ public virtual void Awake()
         public virtual async void Start()
         {
             if (!enabled) return;
-            await SetupLLMClient();
+            await SetupCaller();
             started = true;
         }
 
@@ -240,11 +240,11 @@ protected virtual void Reset()
         #endregion
 
         #region Initialization
-        protected virtual async Task CheckLLMClient(bool checkConnection = true)
+        protected virtual async Task CheckCaller(bool checkConnection = true)
         {
             await startSemaphore.WaitAsync();
             startSemaphore.Release();
-            if (GetCaller() == null) LLMUnitySetup.LogError("LLMClient not initialized", true);
+            if (GetCaller() == null) LLMUnitySetup.LogError("LLM caller not initialized", true);
             if (remote && checkConnection)
             {
                 for (int attempt = 0; attempt <= numRetries; attempt++)
@@ -258,7 +258,16 @@ protected virtual async Task CheckLLMClient(bool checkConnection = true)
         /// <summary>
         /// Sets up the underlying LLM client connection (local or remote).
         /// </summary>
-        protected virtual async Task SetupLLMClient()
+        protected virtual async Task SetupCaller()
+        {
+            await SetupCallerObject();
+            await PostSetupCallerObject();
+        }
+
+        /// <summary>
+        /// Sets up the underlying LLM client connection (local or remote).
+        /// </summary>
+        protected virtual async Task SetupCallerObject()
         {
             await startSemaphore.WaitAsync();
 
@@ -275,9 +284,6 @@ protected virtual async Task SetupLLMClient()
                 {
                     llmClient = new UndreamAI.LlamaLib.LLMClient(host, port, APIKey, numRetries);
                 }
-
-                SetGrammar(grammar);
-                completionParametersCache = "";
             }
             catch (Exception ex)
             {
@@ -297,6 +303,15 @@ protected virtual async Task SetupLLMClient()
             }
         }
 
+        /// <summary>
+        /// Initialisation after setting up the LLM client (local or remote).
+        /// </summary>
+        protected virtual async Task PostSetupCallerObject()
+        {
+            SetGrammar(grammar);
+            completionParametersCache = "";
+        }
+
         /// <summary>
         /// Gets the underlying LLMLocal instance for operations requiring local access.
         /// </summary>
@@ -320,7 +335,7 @@ protected virtual async Task SetLLM(LLM llmInstance)
             }
 
             _llm = llmInstance;
-            if (started) await SetupLLMClient();
+            if (started) await SetupCaller();
         }
 
         #endregion
@@ -497,7 +512,7 @@ public virtual async Task<List<int>> Tokenize(string query, Callback<List<int>>
             {
                 throw new ArgumentNullException(nameof(query));
             }
-            await CheckLLMClient();
+            await CheckCaller();
 
             List<int> tokens = llmClient.Tokenize(query);
             callback?.Invoke(tokens);
@@ -516,7 +531,7 @@ public virtual async Task<string> Detokenize(List<int> tokens, Callback<string>
             {
                 throw new ArgumentNullException(nameof(tokens));
             }
-            await CheckLLMClient();
+            await CheckCaller();
 
             string text = llmClient.Detokenize(tokens);
             callback?.Invoke(text);
@@ -535,7 +550,7 @@ public virtual async Task<List<float>> Embeddings(string query, Callback<List<fl
             {
                 throw new ArgumentNullException(nameof(query));
             }
-            await CheckLLMClient();
+            await CheckCaller();
 
             List<float> embeddings = llmClient.Embeddings(query);
             callback?.Invoke(embeddings);
@@ -553,7 +568,7 @@ public virtual async Task<List<float>> Embeddings(string query, Callback<List<fl
         public virtual async Task<string> Completion(string prompt, LlamaLib.CharArrayCallback callback = null,
             EmptyCallback completionCallback = null, int id_slot = -1)
         {
-            await CheckLLMClient();
+            await CheckCaller();
             SetCompletionParameters();
             string result = await llmClient.CompletionAsync(prompt, callback, id_slot);
             completionCallback?.Invoke();

Original file line number	Diff line number	Diff line change
`@@ -139,9 +139,9 @@ public override void Awake()`
`139`	`139`	`base.Awake();`
`140`	`140`	`}`
`141`	`141`
`142`		`- protected override async Task SetupLLMClient()`
	`142`	`+ protected override async Task SetupCallerObject()`
`143`	`143`	`{`
`144`		`- await base.SetupLLMClient();`
	`144`	`+ await base.SetupCallerObject();`
`145`	`145`
`146`	`146`	`string exceptionMessage = "";`
`147`	`147`	`try`
`@@ -158,7 +158,14 @@ protected override async Task SetupLLMClient()`
`158`	`158`	`if (exceptionMessage != "") error += ", error: " + exceptionMessage;`
`159`	`159`	`LLMUnitySetup.LogError(error, true);`
`160`	`160`	`}`
	`161`	`+ }`
`161`	`162`
	`163`	`+ /// <summary>`
	`164`	`+ /// Initialisation after setting up the LLM client (local or remote).`
	`165`	`+ /// </summary>`
	`166`	`+ protected override async Task PostSetupCallerObject()`
	`167`	`+ {`
	`168`	`+ await base.PostSetupCallerObject();`
`162`	`169`	`if (slot != -1) llmAgent.SlotId = slot;`
`163`	`170`	`await InitHistory();`
`164`	`171`	`}`
`@@ -217,7 +224,7 @@ public virtual string GetSavePath()`
`217`	`224`	`/// </summary>`
`218`	`225`	`public virtual async Task ClearHistory()`
`219`	`226`	`{`
`220`		`- await CheckLLMClient(checkConnection: false);`
	`227`	`+ await CheckCaller(checkConnection: false);`
`221`	`228`	`llmAgent.ClearHistory();`
`222`	`229`	`}`
`223`	`230`
`@@ -228,7 +235,7 @@ public virtual async Task ClearHistory()`
`228`	`235`	`/// <param name="content">Message content</param>`
`229`	`236`	`public virtual async Task AddMessage(string role, string content)`
`230`	`237`	`{`
`231`		`- await CheckLLMClient();`
	`238`	`+ await CheckCaller();`
`232`	`239`	`llmAgent.AddMessage(role, content);`
`233`	`240`	`}`
`234`	`241`
`@@ -238,7 +245,7 @@ public virtual async Task AddMessage(string role, string content)`
`238`	`245`	`/// <param name="content">User message content</param>`
`239`	`246`	`public virtual async Task AddUserMessage(string content)`
`240`	`247`	`{`
`241`		`- await CheckLLMClient();`
	`248`	`+ await CheckCaller();`
`242`	`249`	`llmAgent.AddUserMessage(content);`
`243`	`250`	`}`
`244`	`251`
`@@ -248,7 +255,7 @@ public virtual async Task AddUserMessage(string content)`
`248`	`255`	`/// <param name="content">Assistant message content</param>`
`249`	`256`	`public virtual async Task AddAssistantMessage(string content)`
`250`	`257`	`{`
`251`		`- await CheckLLMClient();`
	`258`	`+ await CheckCaller();`
`252`	`259`	`llmAgent.AddAssistantMessage(content);`
`253`	`260`	`}`
`254`	`261`
`@@ -275,7 +282,7 @@ public class CompletionResponseJson`
`275`	`282`	`public virtual async Task<string> Chat(string query, LlamaLib.CharArrayCallback callback = null,`
`276`	`283`	`EmptyCallback completionCallback = null, bool addToHistory = true)`
`277`	`284`	`{`
`278`		`- await CheckLLMClient();`
	`285`	`+ await CheckCaller();`
`279`	`286`
`280`	`287`	`// Wrap callback to ensure it runs on the main thread`
`281`	`288`	`LlamaLib.CharArrayCallback wrappedCallback = Utils.WrapCallbackForAsync(callback, this);`
`@@ -341,7 +348,7 @@ public virtual async Task SaveHistory()`
`341`	`348`	`LLMUnitySetup.LogError("No save path specified");`
`342`	`349`	`return;`
`343`	`350`	`}`
`344`		`- await CheckLLMClient();`
	`351`	`+ await CheckCaller();`
`345`	`352`
`346`	`353`	`// Save chat history`
`347`	`354`	`string jsonPath = GetSavePath();`
`@@ -373,7 +380,7 @@ public virtual async Task LoadHistory()`
`373`	`380`	`LLMUnitySetup.LogError("No save path specified");`
`374`	`381`	`return;`
`375`	`382`	`}`
`376`		`- await CheckLLMClient();`
	`383`	`+ await CheckCaller();`
`377`	`384`
`378`	`385`	`// Load chat history`
`379`	`386`	`string jsonPath = GetSavePath();`
Original file line number	Diff line number	Diff line change
`@@ -132,7 +132,7 @@ public bool remote`
`132`	`132`	`if (_remote != value)`
`133`	`133`	`{`
`134`	`134`	`_remote = value;`
`135`		`- if (started) _ = SetupLLMClient();`
	`135`	`+ if (started) _ = SetupCaller();`
`136`	`136`	`}`
`137`	`137`	`}`
`138`	`138`	`}`
`@@ -153,7 +153,7 @@ public string APIKey`
`153`	`153`	`if (_APIKey != value)`
`154`	`154`	`{`
`155`	`155`	`_APIKey = value;`
`156`		`- if (started) _ = SetupLLMClient();`
	`156`	`+ if (started) _ = SetupCaller();`
`157`	`157`	`}`
`158`	`158`	`}`
`159`	`159`	`}`
`@@ -167,7 +167,7 @@ public string host`
`167`	`167`	`if (_host != value)`
`168`	`168`	`{`
`169`	`169`	`_host = value;`
`170`		`- if (started) _ = SetupLLMClient();`
	`170`	`+ if (started) _ = SetupCaller();`
`171`	`171`	`}`
`172`	`172`	`}`
`173`	`173`	`}`
`@@ -181,7 +181,7 @@ public int port`
`181`	`181`	`if (_port != value)`
`182`	`182`	`{`
`183`	`183`	`_port = value;`
`184`		`- if (started) _ = SetupLLMClient();`
	`184`	`+ if (started) _ = SetupCaller();`
`185`	`185`	`}`
`186`	`186`	`}`
`187`	`187`	`}`
`@@ -223,7 +223,7 @@ public virtual void Awake()`
`223`	`223`	`public virtual async void Start()`
`224`	`224`	`{`
`225`	`225`	`if (!enabled) return;`
`226`		`- await SetupLLMClient();`
	`226`	`+ await SetupCaller();`
`227`	`227`	`started = true;`
`228`	`228`	`}`
`229`	`229`
`@@ -240,11 +240,11 @@ protected virtual void Reset()`
`240`	`240`	`#endregion`
`241`	`241`
`242`	`242`	`#region Initialization`
`243`		`- protected virtual async Task CheckLLMClient(bool checkConnection = true)`
	`243`	`+ protected virtual async Task CheckCaller(bool checkConnection = true)`
`244`	`244`	`{`
`245`	`245`	`await startSemaphore.WaitAsync();`
`246`	`246`	`startSemaphore.Release();`
`247`		`- if (GetCaller() == null) LLMUnitySetup.LogError("LLMClient not initialized", true);`
	`247`	`+ if (GetCaller() == null) LLMUnitySetup.LogError("LLM caller not initialized", true);`
`248`	`248`	`if (remote && checkConnection)`
`249`	`249`	`{`
`250`	`250`	`for (int attempt = 0; attempt <= numRetries; attempt++)`
`@@ -258,7 +258,16 @@ protected virtual async Task CheckLLMClient(bool checkConnection = true)`
`258`	`258`	`/// <summary>`
`259`	`259`	`/// Sets up the underlying LLM client connection (local or remote).`
`260`	`260`	`/// </summary>`
`261`		`- protected virtual async Task SetupLLMClient()`
	`261`	`+ protected virtual async Task SetupCaller()`
	`262`	`+ {`
	`263`	`+ await SetupCallerObject();`
	`264`	`+ await PostSetupCallerObject();`
	`265`	`+ }`
	`266`	`+`
	`267`	`+ /// <summary>`
	`268`	`+ /// Sets up the underlying LLM client connection (local or remote).`
	`269`	`+ /// </summary>`
	`270`	`+ protected virtual async Task SetupCallerObject()`
`262`	`271`	`{`
`263`	`272`	`await startSemaphore.WaitAsync();`
`264`	`273`
`@@ -275,9 +284,6 @@ protected virtual async Task SetupLLMClient()`
`275`	`284`	`{`
`276`	`285`	`llmClient = new UndreamAI.LlamaLib.LLMClient(host, port, APIKey, numRetries);`
`277`	`286`	`}`
`278`		`-`
`279`		`- SetGrammar(grammar);`
`280`		`- completionParametersCache = "";`
`281`	`287`	`}`
`282`	`288`	`catch (Exception ex)`
`283`	`289`	`{`
`@@ -297,6 +303,15 @@ protected virtual async Task SetupLLMClient()`
`297`	`303`	`}`
`298`	`304`	`}`
`299`	`305`
	`306`	`+ /// <summary>`
	`307`	`+ /// Initialisation after setting up the LLM client (local or remote).`
	`308`	`+ /// </summary>`
	`309`	`+ protected virtual async Task PostSetupCallerObject()`
	`310`	`+ {`
	`311`	`+ SetGrammar(grammar);`
	`312`	`+ completionParametersCache = "";`
	`313`	`+ }`
	`314`	`+`
`300`	`315`	`/// <summary>`
`301`	`316`	`/// Gets the underlying LLMLocal instance for operations requiring local access.`
`302`	`317`	`/// </summary>`
`@@ -320,7 +335,7 @@ protected virtual async Task SetLLM(LLM llmInstance)`
`320`	`335`	`}`
`321`	`336`
`322`	`337`	`_llm = llmInstance;`
`323`		`- if (started) await SetupLLMClient();`
	`338`	`+ if (started) await SetupCaller();`
`324`	`339`	`}`
`325`	`340`
`326`	`341`	`#endregion`
`@@ -497,7 +512,7 @@ public virtual async Task<List<int>> Tokenize(string query, Callback<List<int>>`
`497`	`512`	`{`
`498`	`513`	`throw new ArgumentNullException(nameof(query));`
`499`	`514`	`}`
`500`		`- await CheckLLMClient();`
	`515`	`+ await CheckCaller();`
`501`	`516`
`502`	`517`	`List<int> tokens = llmClient.Tokenize(query);`
`503`	`518`	`callback?.Invoke(tokens);`
`@@ -516,7 +531,7 @@ public virtual async Task<string> Detokenize(List<int> tokens, Callback<string>`
`516`	`531`	`{`
`517`	`532`	`throw new ArgumentNullException(nameof(tokens));`
`518`	`533`	`}`
`519`		`- await CheckLLMClient();`
	`534`	`+ await CheckCaller();`
`520`	`535`
`521`	`536`	`string text = llmClient.Detokenize(tokens);`
`522`	`537`	`callback?.Invoke(text);`
`@@ -535,7 +550,7 @@ public virtual async Task<List<float>> Embeddings(string query, Callback<List<fl`
`535`	`550`	`{`
`536`	`551`	`throw new ArgumentNullException(nameof(query));`
`537`	`552`	`}`
`538`		`- await CheckLLMClient();`
	`553`	`+ await CheckCaller();`
`539`	`554`
`540`	`555`	`List<float> embeddings = llmClient.Embeddings(query);`
`541`	`556`	`callback?.Invoke(embeddings);`
`@@ -553,7 +568,7 @@ public virtual async Task<List<float>> Embeddings(string query, Callback<List<fl`
`553`	`568`	`public virtual async Task<string> Completion(string prompt, LlamaLib.CharArrayCallback callback = null,`
`554`	`569`	`EmptyCallback completionCallback = null, int id_slot = -1)`
`555`	`570`	`{`
`556`		`- await CheckLLMClient();`
	`571`	`+ await CheckCaller();`
`557`	`572`	`SetCompletionParameters();`
`558`	`573`	`string result = await llmClient.CompletionAsync(prompt, callback, id_slot);`
`559`	`574`	`completionCallback?.Invoke();`