Codeunit 4303 Agent Task

System Application, System.Agents

src/System Application/App/Agent/Interaction/AgentTask.Codeunit.al339 lines, Copyright (c) Microsoft Corporation. MIT

// ------------------------------------------------------------------------------------------------// Copyright (c) Microsoft Corporation. All rights reserved.// Licensed under the MIT License. See License.txt in the project root for license information.// ------------------------------------------------------------------------------------------------namespace System.Agents;using System.Environment;codeunit 4303 "Agent Task"{    InherentEntitlements = X;    InherentPermissions = X;    /// <summary>    /// Check if a task exists for the given agent user and conversation    /// </summary>    /// <param name="AgentUserSecurityId">The user security ID of the agent.</param>    /// <param name="ExternalId">The external ID to check.</param>    /// <returns>True if task exists, false if not.</returns>    procedure TaskExists(AgentUserSecurityId: Guid; ExternalId: Text): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.TaskExists(AgentUserSecurityId, ExternalId));    end;    /// <summary>    /// Get the task for the given agent user and external ID.    /// </summary>    /// <param name="AgentUserSecurityId">The agent user ID.</param>    /// <param name="ExternalId">The external ID of the task.</param>    /// <returns>A record with the given task.</returns>    procedure GetTaskByExternalId(AgentUserSecurityId: Guid; ExternalId: Text): Record "Agent Task"    var        AgentTask: Record "Agent Task";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTask.SetRange("Agent User Security ID", AgentUserSecurityId);        AgentTask.SetRange("External ID", ExternalId);        AgentTask.FindFirst();        exit(AgentTask);    end;    /// <summary>    /// Set the status of the task to ready if the task is in the state that it can be started again.    /// The agent task will be be picked up for processing shortly after updating the status.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to set to ready.</param>    procedure SetStatusToReady(AgentTaskID: BigInteger)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.SetTaskStatusToReadyIfPossible(AgentTaskID);    end;#if not CLEAN29    /// <summary>    /// Set the status of the task to ready if the task is in the state that it can be started again.    /// The agent task will be be picked up for processing shortly after updating the status.    /// </summary>    /// <param name="AgentTask">The agent task to set to ready.</param>    /// <returns>The agent task with the status set to ready.</returns>    [Obsolete('Use the overload that takes AgentTaskID instead.', '29.0')]    procedure SetStatusToReady(var AgentTask: Record "Agent Task")    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.SetTaskStatusToReadyIfPossible(AgentTask);    end;#endif    /// <summary>    /// Checks if the task can be set to ready and started again.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to check.</param>    /// <returns>True if agent task can be set to ready, false otherwise</returns>    procedure CanSetStatusToReady(AgentTaskID: BigInteger): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.CanAgentTaskBeSetToReady(AgentTaskID));    end;    /// <summary>    /// Checks if the task can be set to ready and started again.    /// The record is not retrieved again; the caller must ensure the record is up to date.    /// </summary>    /// <param name="AgentTask">The agent task to check.</param>    /// <returns>True if agent task can be set to ready, false otherwise</returns>    procedure CanSetStatusToReady(AgentTask: Record "Agent Task"): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.CanAgentTaskBeSetToReady(AgentTask));    end;    /// <summary>    /// Stops the agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to stop.</param>    /// <param name="UserConfirm">Whether to show a confirmation dialog to the user.</param>    procedure StopTask(AgentTaskID: BigInteger; UserConfirm: Boolean)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";        TaskStatus: Enum "Agent Task Status";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.StopTask(AgentTaskID, TaskStatus::"Stopped by User", UserConfirm);    end;#if not CLEAN29    /// <summary>    /// Stops the agent task.    /// </summary>    /// <param name="AgentTask">The agent task to stop.</param>    /// <param name="UserConfirm">Whether to show a confirmation dialog to the user.</param>    [Obsolete('Use the overload that takes AgentTaskID instead.', '29.0')]    procedure StopTask(var AgentTask: Record "Agent Task"; UserConfirm: Boolean)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";        TaskStatus: Enum "Agent Task Status";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.StopTask(AgentTask, TaskStatus::"Stopped by User", UserConfirm);    end;#endif    /// <summary>    /// Restarts the agent task by setting its status to ready.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to restart.</param>    /// <param name="UserConfirm">Whether to show a confirmation dialog to the user.</param>    procedure RestartTask(AgentTaskID: BigInteger; UserConfirm: Boolean)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.RestartTask(AgentTaskID, UserConfirm);    end;#if not CLEAN29    /// <summary>    /// Restarts the agent task by setting its status to ready.    /// </summary>    /// <param name="AgentTask">The agent task to restart.</param>    /// <param name="UserConfirm">Whether to show a confirmation dialog to the user.</param>    [Obsolete('Use the overload that takes AgentTaskID instead.', '29.0')]    procedure RestartTask(var AgentTask: Record "Agent Task"; UserConfirm: Boolean)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.RestartTask(AgentTask, UserConfirm);    end;#endif    /// <summary>    /// Checks if the agent task is currently running.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to check.</param>    /// <returns>True if the task is running, false otherwise.</returns>    procedure IsTaskRunning(AgentTaskID: BigInteger): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskRunning(AgentTaskID));    end;    /// <summary>    /// Checks if the agent task is currently running.    /// The record is not retrieved again; the caller must ensure the record is up to date.    /// </summary>    /// <param name="AgentTask">The agent task to check.</param>    /// <returns>True if the task is running, false otherwise.</returns>    procedure IsTaskRunning(var AgentTask: Record "Agent Task"): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskRunning(AgentTask));    end;    /// <summary>    /// Checks if the agent task is completed.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to check.</param>    /// <returns>True if the task is completed, false otherwise.</returns>    procedure IsTaskCompleted(AgentTaskID: BigInteger): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskCompleted(AgentTaskID));    end;    /// <summary>    /// Checks if the agent task is completed.    /// The record is not retrieved again; the caller must ensure the record is up to date.    /// </summary>    /// <param name="AgentTask">The agent task to check.</param>    /// <returns>True if the task is completed, false otherwise.</returns>    procedure IsTaskCompleted(var AgentTask: Record "Agent Task"): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskCompleted(AgentTask));    end;    /// <summary>    /// Checks if the agent task is stopped (by user or system).    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to check.</param>    /// <returns>True if the task is stopped, false otherwise.</returns>    procedure IsTaskStopped(AgentTaskID: BigInteger): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskStopped(AgentTaskID));    end;    /// <summary>    /// Checks if the agent task is stopped (by user or system).    /// The record is not retrieved again; the caller must ensure the record is up to date.    /// </summary>    /// <param name="AgentTask">The agent task to check.</param>    /// <returns>True if the task is stopped, false otherwise.</returns>    procedure IsTaskStopped(var AgentTask: Record "Agent Task"): Boolean    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.IsTaskStopped(AgentTask));    end;#if not CLEAN29    /// <summary>    /// Gets the total Copilot credits consumed by the agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to get consumed credits for.</param>    /// <returns>The total Copilot credits consumed by the agent task.</returns>    [Obsolete('Use the methods in the "Agent Consumption Overview" codeunit instead.', '29.0')]    procedure GetCopilotCreditsConsumed(AgentTaskID: BigInteger): Decimal    var        AgentConsumptionOverview: Codeunit "Agent Consumption Overview";    begin        exit(AgentConsumptionOverview.GetCopilotCreditsConsumed(AgentTaskID));    end;#endif    /// <summary>    /// Gets the details for the specified agent task log entry.    /// </summary>    /// <param name="AgentTaskLogEntry">The agent task log entry to get details for.</param>    /// <returns>The details of the agent task log entry.</returns>    [Scope('OnPrem')]    procedure GetLogEntryDetails(var AgentTaskLogEntry: Record "Agent Task Log Entry"): Text    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        exit(AgentTaskImpl.GetDetailsForAgentTaskLogEntry(AgentTaskLogEntry));    end;    /// <summary>    /// Gets the number of steps done for the specified agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task.</param>    /// <returns>The number of steps done.</returns>    procedure GetStepsDoneCount(AgentTaskID: BigInteger): Integer    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.GetStepsDoneCount(AgentTaskID));    end;    /// <summary>    /// Opens the agent task log entries page for the specified agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to show log entries for.</param>    procedure OpenAgentTaskLogEntries(AgentTaskID: BigInteger)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.ShowTaskLogEntries(AgentTaskID);    end;    /// <summary>    /// Archives the agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task to archive.</param>    /// <param name="UserConfirm">Whether to show a confirmation dialog to the user.</param>    [Scope('OnPrem')]    procedure ArchiveTask(AgentTaskID: BigInteger; UserConfirm: Boolean)    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        AgentTaskImpl.ArchiveTask(AgentTaskID, UserConfirm);    end;    /// <summary>    /// Gets the model ID of the agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task.</param>    /// <returns>The model ID of the agent task. Must be valid value from Agent Model table.</returns>    procedure GetModelId(AgentTaskID: BigInteger): Code[30]    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.GetModelId(AgentTaskID));    end;    /// <summary>    /// Gets the model name of the agent task.    /// </summary>    /// <param name="AgentTaskID">The ID of the agent task.</param>    /// <returns>The model name of the agent task.</returns>    procedure GetModelName(AgentTaskID: BigInteger): Text[70]    var        AgentTaskImpl: Codeunit "Agent Task Impl.";    begin        FeatureAccessManagement.AgentManagementAllowed(true);        exit(AgentTaskImpl.GetModelName(AgentTaskID));    end;    var        FeatureAccessManagement: Codeunit "Feature Access Management";}