STAROps:GetDigitalEmployee

Retrieves a digital employee.

Hook configuration

You can configure hooks for the digital employee by using toolPolicy.hooks. Each item corresponds to an event and a handler, and is loaded and executed in the order of the array. Hooks with the same name are executed independently. A hook is executed only when enable is set to true and the scope, event, and tool name match. An empty array indicates that no hooks are loaded for the digital employee.

• schemaVersion: The configuration protocol version. Set the value to v1.

• name: The non-empty name. Only English letters, digits, underscores (_), and hyphens (-) are allowed.

• scope: The scope. Valid values: all (Chat and Mission), chat, and mission.

• event: The event. Valid values: TurnStart, TurnEnd, ToolStart, and ToolEnd.

• match: The array of tool names. This parameter is only used for ToolStart and ToolEnd. It performs exact matching based on the actual name and does not support wildcards. An empty array does not limit the tools. This field is ignored for other events.

• execution.type: The execution type. Valid values: prompt, bash, python3, and hint. The instruction field must be filled with a prompt, a Bash script, a Python 3 script, or text appended to the context, and must be non-empty UTF-8 text.

• execution.timeoutSeconds: The timeout period, which ranges from 1 to 30 seconds. All attempts and waits share this timeout period.

• execution.maxRetry: The number of additional attempts after a failure. Valid values: 0 to 3.

• execution.failResult: The action to take if the handler return value is still invalid after retries. Valid values: allow and reject.

Global automatic pass policy

You can configure automatic pass rules for commands by using toolPolicy.global.autoPassPolicy. Each rule must provide version: "v1.0.0" and use one of the following two matching methods:

• fullCommand: The exact non-empty full command to match.

• commandPrefix: The array of command prefixes. It must contain exactly one non-empty prefix.

You cannot configure both fullCommand and commandPrefix at the same time, and you cannot omit both. The rules here use the command format, whereas toolPolicy.aliyun.autoPassPolicy uses RAM action strings. The two formats are different.

The following example shows the configuration of these two parts in toolPolicy:

{
  "global": {
    "autoPassPolicy": [
      {
        "version": "v1.0.0",
        "fullCommand": "starops tool list"
      },
      {
        "version": "v1.0.0",
        "commandPrefix": [
          "starops sls"
        ]
      }
    ]
  },
  "hooks": [
    {
      "schemaVersion": "v1",
      "name": "tool-reminder",
      "enable": true,
      "scope": "all",
      "event": "ToolStart",
      "match": [
        "Bash"
      ],
      "execution": {
        "type": "hint",
        "instruction": "Confirm the target resources and parameters before executing the tool.",
        "timeoutSeconds": 10,
        "maxRetry": 0,
        "failResult": "reject"
      }
    }
  ]
}