Skip to content

Latest commit

 

History

History
106 lines (94 loc) · 3.2 KB

stdAction.md

File metadata and controls

106 lines (94 loc) · 3.2 KB

文本生成式人工智能Action标准【客户端】

OpenProject-AI/stdAction-Local

动作列表

  1. 文件读写
  • 读文件:FR
    • ~+~action File read --path="文件路径"~-~
  • 写文件:FW
    • ~+~action File write --path="文件路径" --content="写入内容"~-~
  • 删除文件:FD
    • ~+~action File delete --path="文件路径"~-~
  1. 目录操作
  • 创建目录:DC
    • ~+~action Directory create --path="目录路径"~-~
  • 删除目录:DD
    • ~+~action Directory delete --path="目录路径"~-~
  • 阅读目录:DR
    • ~+~action Directory read --path="目录路径"~-~
  1. 命令执行
  • 执行命令:CE
    • ~+~action Command execute --command="命令"~-~
  1. 网络
  • 发送GET请求:NG
    • ~+~action Network send get --url="请求地址"~-~
  • 发送POST请求:NP
    • ~+~action Network send post --url="请求地址" --data="请求数据"~-~
  • 发送PUT请求:NU
    • ~+~action Network send put --url="请求地址" --data="请求数据"~-~
  • 发送DELETE请求:ND
    • ~+~action Network send delete --url="请求地址"~-~
  • 发送HEAD请求:NH
    • ~+~action Network send head --url="请求地址"~-~
  • 发送OPTIONS请求:NO
    • ~+~action Network send options --url="请求地址"~-~
  1. 注释/提示:
  • 注释:CM
    • ~+~action Comment --content="注释内容"~-~
  • 提示:TP
    • ~+~action Tip --content="提示内容"~-~
  • 警告:WG
    • ~+~action Warning --content="警告内容"~-~
  • 错误:ER
    • ~+~action Error --content="错误内容"~-~

结果返回标准

~+~action-callback~-~开头,后面跟着动作的执行结果,结尾是~-~,YAML格式。

字段说明

  • action_type:动作类型,如FileDirectoryCommandNetworkCommentTipWarningError等。
  • action:动作名称,如readcreateexecutesend等,注释/提示动作动作名称为commenttipwarningerror
  • is_ok:动作是否成功,yes表示成功,no表示失败。
  • content:动作执行结果,如文件内容、目录列表、命令执行结果等。
  • extra: 额外信息,如网络请求的响应时间、命令执行的返回码等。可以自行定义。

示例

~+~action-callback~-~
action_type: File
action: read
is_ok: yes
content: |
    content of file.
extra: null
~-~

Markdown提示适配的写法

# XX 项目
## STDAction-Local标准支持进度
### 动作列表
#### 文件读写
- [x] `FR` 读文件
- [x] `FW` 写文件
- [x] `FD` 删除文件
#### 目录操作
- [x] `DC` 创建目录
- [x] `DD` 删除目录
- [x] `DR` 阅读目录
#### 命令执行
- [x] `CE` 执行命令
#### 网络
- [x] `NG` 发送GET请求
- [x] `NP` 发送POST请求
- [x] `NU` 发送PUT请求
- [x] `ND` 发送DELETE请求
- [x] `NH` 发送HEAD请求
- [x] `NO` 发送OPTIONS请求
#### 注释/提示
- [x] `CM` 注释
- [x] `TP` 提示
- [x] `WG` 警告
- [x] `ER` 错误

注:[x]表示已完成,[ ]表示未完成(中间有个空格,Github可以识别)。

本协议采用Apache License 2.0许可。

标准名字:OpenProject/stdAction-Local

版本:v1.0.0

发布日期:2025-03-15