metadata:
author: DataAgent Team
version: "1.7.2"
Changelog
- - v1.7.2: Use Alibaba Cloud default credential chain instead of explicit AK/SK, add User-Agent header, fix RAM policy wildcard issues
- v1.7.1: Fix CLI
ls command API response parsing (support case-insensitive field names), optimize SKILL documentation structure, separate ANALYSIS mode specification document - v1.7.0: API_KEY authentication support, native async execution mode, session isolation, enhanced attach mode, optimized log output
Installation
Configure Credentials
This Skill uses Alibaba Cloud default credential chain (recommended) or API_KEY authentication.
Option 1: Default Credential Chain (Recommended)
The Skill uses Alibaba Cloud SDK's default credential chain to automatically obtain credentials, supporting environment variables, configuration files, instance roles, etc.
See Alibaba Cloud Credential Chain Documentation
Option 2: API_KEY Authentication (File Analysis Only)
CODEBLOCK0
Get APIKEY: Data Agent Console
Permission Requirements
RAM users need AliyunDMSFullAccess or AliyunDMSDataAgentFullAccess permissions.
See RAM-POLICIES.md for detailed permission information.
Debug Mode
CODEBLOCK1
💡 Getting Started Tips
- - Use the built-in demo database
internal_data_employees (DataAgent's built-in test database containing employee, department, and salary data) for first-time experience - Or use local file
assets/example_game_data.csv for file analysis experience
Data Agent CLI — Unified Command-Line Data Analysis Tool
Overview
INLINECODE5 helps users complete the full workflow from discover data → initiate analysis → track progress → get results.
Core Concepts
⚠️ Key Prerequisite: Data Agent can only analyze databases that have been imported into Data Agent Data Center.
- - Data Center: Data Agent's data center, only databases here can be analyzed
- DMS: Alibaba Cloud Data Management Service, stores metadata of all databases
- Relationship: Databases registered in DMS ≠ Databases in Data Center
Usage Flow:
- 1. First use
ls to check if the target database exists in Data Center - If not found, use
dms subcommand to search for database info, then use import subcommand to import it - After successful import, you can use
db subcommand for analysis
Analysis Modes
- - ASK_DATA (default): Synchronous execution, sub-second response, suitable for quick Q&A
- ANALYSIS: Deep analysis, takes 5-40 minutes, requires spawning a sub-agent for async execution or using --async-run parameter
See ANALYSIS_MODE.md for details
Session Reuse
Use db/file to create a session for initial analysis, then use attach --session-id <ID> to reuse the session for follow-up questions.
See COMMANDS.md and WORKFLOWS.md for details
Quick Start
CODEBLOCK2
📖 See WORKFLOWS.md and COMMANDS.md for complete workflows, command reference, and best practices
Project Structure
CODEBLOCK3
技能名称: alibabacloud-data-agent-skill
详细描述:
metadata:
author: DataAgent Team
version: 1.7.2
更新日志
- - v1.7.2: 使用阿里云默认凭据链替代显式AK/SK,添加User-Agent请求头,修复RAM策略通配符问题
- v1.7.1: 修复CLI ls命令API响应解析(支持不区分大小写的字段名),优化SKILL文档结构,分离ANALYSIS模式规范文档
- v1.7.0: 支持API_KEY认证,原生异步执行模式,会话隔离,增强的attach模式,优化日志输出
安装
配置凭据
本技能使用阿里云默认凭据链(推荐)或API_KEY认证。
选项1:默认凭据链(推荐)
技能使用阿里云SDK的默认凭据链自动获取凭据,支持环境变量、配置文件、实例角色等方式。
参见阿里云凭据链文档
选项2:API_KEY认证(仅限文件分析)
bash
export DATAAGENTAPI_KEY=your-api-key
export DATAAGENTREGION=cn-hangzhou
获取APIKEY:Data Agent控制台
权限要求
RAM用户需要AliyunDMSFullAccess或AliyunDMSDataAgentFullAccess权限。
详细权限信息请参见RAM-POLICIES.md。
调试模式
bash
DATAAGENTDEBUGAPI=1 python3 scripts/dataagent_cli.py file example.csv -q analyze
💡 入门提示
- - 使用内置演示数据库internaldataemployees(DataAgent内置测试数据库,包含员工、部门和薪资数据)进行首次体验
- 或使用本地文件assets/examplegamedata.csv体验文件分析功能
Data Agent CLI — 统一命令行数据分析工具
概述
scripts/dataagentcli.py帮助用户完成从发现数据 → 发起分析 → 跟踪进度 → 获取结果的完整工作流程。
核心概念
⚠️ 关键前提:Data Agent只能分析已导入Data Agent数据中心的数据库。
- - 数据中心:Data Agent的数据中心,只有这里的数据库才能被分析
- DMS:阿里云数据管理服务,存储所有数据库的元数据
- 关系:在DMS中注册的数据库 ≠ 在数据中心中的数据库
使用流程:
- 1. 首先使用ls检查目标数据库是否存在于数据中心
- 如果未找到,使用dms子命令搜索数据库信息,然后使用import子命令导入
- 导入成功后,即可使用db子命令进行分析
分析模式
- - ASK_DATA(默认):同步执行,亚秒级响应,适用于快速问答
- ANALYSIS:深度分析,耗时5-40分钟,需要生成子代理进行异步执行或使用--async-run参数
详情请参见ANALYSIS_MODE.md
会话复用
使用db/file创建初始分析会话,然后使用attach --session-id 复用该会话进行后续提问。
详情请参见COMMANDS.md和WORKFLOWS.md
快速开始
bash
1. 列出可用数据库
python3 scripts/data
agentcli.py ls
2. 查询分析(同步响应)
python3 scripts/data
agentcli.py db \
--dms-instance-id
--dms-db-id \
--instance-name --db-name \
--tables employees,departments -q 哪个部门的平均薪资最高
3. 追问(复用会话)
python3 scripts/dataagentcli.py attach --session-id -q 按月细分
📖 完整工作流程、命令参考和最佳实践请参见WORKFLOWS.md和COMMANDS.md
项目结构
# 技能根目录
├── SKILL.md # 本文档
├── scripts/ # 源代码
│ ├── data_agent/ # SDK模块
│ ├── cli/ # CLI模块
│ ├── dataagentcli.py # CLI入口
│ └── requirements.txt # 依赖
├── sessions/ # 会话数据
└── references/ # 参考文档