add compat remark as comment

microsoft · Oct 21, 2024 · c6648c3 · c6648c3
1 parent bc67f11
commit c6648c3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 0 deletions.
diff --git a/dotnet/packages/Microsoft.TeamsAI/Microsoft.TeamsAI/AI/AIConstants.cs b/dotnet/packages/Microsoft.TeamsAI/Microsoft.TeamsAI/AI/AIConstants.cs
@@ -24,6 +24,9 @@ public static class AIConstants
         /// <summary>
         /// The type of command that will stop the running.
         /// </summary>
+        /// <remarks>
+        /// This command is incompatible and should not be used with `tools` augmentation 
+        /// </remarks>
         public const string StopCommand = "STOP";
 
         /// <summary>

diff --git a/js/packages/teams-ai/src/AI.ts b/js/packages/teams-ai/src/AI.ts
@@ -120,6 +120,8 @@ export class AI<TState extends TurnState = TurnState> {
     /**
      * A text string that can be returned from an action to stop the AI system from continuing
      * to execute the current plan.
+     * @remarks
+     * This command is incompatible and should not be used with `tools` augmentation 
      */
     public static readonly StopCommandName = actions.StopCommandName;
 

diff --git a/python/packages/ai/teams/ai/actions/action_types.py b/python/packages/ai/teams/ai/actions/action_types.py
@@ -10,6 +10,8 @@
 
 class ActionTypes(str, Enum):
     STOP = "STOP"
+    "This command is incompatible and should not be used with `tools` augmentation"
+
     UNKNOWN_ACTION = "___UnknownAction___"
     FLAGGED_INPUT = "___FlaggedInput___"
     FLAGGED_OUTPUT = "___FlaggedOutput___"