mcpField
I
interactiveai

interactiveai

github.com/interactive-ai-labsAgent 工作流42 次安装
代码仓库

关于 interactiveai

InteractiveAI 是面向平台开发者的技能,指导应用埋点、提示词迁移、结构化提示词处理和资源管理,并强调先查阅文档及使用 iai 命令行。

主要功能

  1. 01应用埋点指导
  2. 02提示词迁移工作流
  3. 03结构化提示词支持
  4. 04平台资源管理
  5. 05iai 命令行使用指导

适用场景

  1. 01为应用接入 InteractiveAI 埋点
  2. 02将代码库中的提示词迁移到 InteractiveAI
  3. 03编辑结构化提示词
  4. 04使用 iai 检查平台资源

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/interactive-ai-labs/skills --skill interactiveai

安装后在 Claude Code 中输入/interactiveai确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
cli.md
instrumentation.md
prompt-migration.md
structured-prompts.md

详细介绍

InteractiveAI

此技能可帮助你在常见工作流中有效使用 InteractiveAI:为应用埋点、迁移提示词、管理平台资源以及查阅文档。

核心原则

在所有 InteractiveAI 工作中遵循以下原则:

  1. 文档优先:绝不可凭记忆实现。编写代码前始终先获取最新文档。请参阅下文的文档部分。
  2. 优先发现 CLI 命令和 Schema:更改 InteractiveAI 资源前,使用 iai --help、iai <command> --help 和 iai <command> <subcommand> --help 确认准确的命令格式。对于结构化提示词,在可用时使用 iai <type> schema。
  3. 根据使用场景遵循最佳实践:实现前查看下方相关的参考文件。
  4. 默认获取最新提示词:读取提示词或接入提示词获取功能时,使用 latest 版本,除非用户明确要求其他标签或固定版本。
  5. 对线上更改明确确认:扩缩服务或副本,或为提示词版本指定 production 标签,都会改变线上行为。除非用户明确确认,否则不要执行这些操作。
  6. 使用最新的 InteractiveAI 版本:除非用户另有指定或有充分理由不这样做,否则使用最新的 InteractiveAI SDK 和 API 版本。

按使用场景分类的参考资料

  • 为现有函数/应用埋点:references/instrumentation.md
  • 将代码库中的提示词迁移到 InteractiveAI:references/prompt-migration.md
  • 使用结构化提示词类型(routine、policy、variable、glossary、macro):references/structured-prompts.md
  • 使用 iai CLI 的更多技巧:references/cli.md

1. InteractiveAI CLI(iai)

使用 iai CLI 管理平台资源并检查数据。与基于 npx 的工具不同,iai 必须在本地安装。

首先确认是否可用并了解命令格式:

iai --help
iai <command> --help
iai <command> <subcommand> --help

对于结构化提示词相关工作,也请在可用时检查类型 Schema:

iai <type> schema

如果尚未安装 iai,请安装最新版本:

go install github.com/Interactive-AI-Labs/interactive-cli/cmd/iai@latest
export PATH=$PATH:$(go env GOPATH)/bin
凭据

使用 SDK 或 CLI 前,请先设置以下环境变量:

export INTERACTIVEAI_PUBLIC_KEY=pk-lf-...
export INTERACTIVEAI_SECRET_KEY=sk-lf-...
export INTERACTIVEAI_HOST=https://app.interactive.ai
export INTERACTIVE_API_KEY=$INTERACTIVEAI_PUBLIC_KEY:$INTERACTIVEAI_SECRET_KEY

必须始终设置 INTERACTIVEAI_HOST。如果无法获取凭据,请向用户索取其 InteractiveAI Settings 中的 API 密钥。

防护措施
  • 运行会更改容量的 iai services 或 iai replicas 命令前,请先征求确认。
  • 提示词版本会自动获得 latest。除非用户明确确认希望新版本立即上线,否则不要添加 --labels production。
  • 如果任务会替换当前生产环境使用的版本,请停止并在继续前直接征求确认。
CLI 详细参考

有关常见工作流、身份验证详情和用法模式,请参阅 references/cli.md。

2. InteractiveAI 文档

有两种方式可以访问 InteractiveAI 文档,按优先顺序排列。有可用的原生网页抓取/搜索工具时,始终优先使用,而不要使用 curl。以下 URL 格式适用于任何抓取方式;curl 示例仅供参考。

2a. 文档索引(llms.txt)

获取完整的文档索引:

curl -s https://docs.interactive.ai/llms.txt

该索引会返回文档标题和相对路径。为每个路径添加前缀 https://docs.interactive.ai,即可组成完整 URL。

或者从 https://docs.interactive.ai 开始,导航到相关页面。

2b. 将单个页面作为 Markdown 获取

llms.txt 中列出的任何页面,都可以通过在其路径末尾添加 .md 作为 Markdown 获取:

curl -s "https://docs.interactive.ai/sdk/tracing.md"
curl -s "https://docs.interactive.ai/sdk/prompts.md"
curl -s "https://docs.interactive.ai/cli/iai.md"
文档工作流
  1. 从 llms.txt 开始,找到合适的页面。
  2. 确认相关指南所在位置后,获取对应的 Markdown 页面。

评论

支持 Markdown