GenAIScript

提示词即代码

使用 JavaScript 以编程方式组装大型语言模型的提示词。在代码中编排 LLM、工具和数据。

• 用于处理提示词的 JavaScript 工具箱

• 简化操作并提高效率的抽象层

• 无缝集成 Visual Studio Code 或灵活的命令行界面

• 内置对 GitHub Copilot 和 GitHub Models、OpenAI、Azure OpenAI、Anthropic 等的支持

• 📄 在线文档请访问 microsoft.github.io/genaiscript

• 💬 加入 Discord 服务器

• 📝 阅读 博客 获取最新资讯

• 📺 观看 前田先生的温馨 AI 厨房

• 🤖 代理 - 阅读 llms-full.txt

---

Hello world

假设你想创建一个生成“hello world”诗歌的 LLM 脚本。你可以编写如下脚本：

$`写一首“hello world”诗。`

$ 函数是一个模板标签，用于创建提示词。随后，该提示词会被发送到你已配置的 LLM，由其生成诗歌。

让我们通过添加文件、数据和结构化输出来使它更有趣。假设你想在提示词中包含一个文件，并将输出保存到另一个文件中。你可以编写如下脚本：

// 读取文件
const file = await workspace.readText("data.txt")
// 以适合上下文的方式将文件内容纳入提示词
def("DATA", file)
// 任务
$`分析 DATA，并将数据提取为 JSON 格式，保存到 data.json 中。`

def 函数会将文件内容纳入提示词，并在必要时为目标 LLM 进行优化。GenAIScript 脚本还会解析 LLM 的输出，并自动提取出 data.json 文件。

---

🚀 快速入门指南

通过安装 Visual Studio Code 扩展 或使用 命令行 即可快速上手。

---

✨ 功能特性

🎨 风格化的 JavaScript 和 TypeScript

使用 JavaScript 或 TypeScript 以编程方式构建提示词。

def("FILE", env.files, { endsWith: ".pdf" })
$`总结 FILE。今天是 ${new Date()}。`

---

🚀 快速开发循环

在 Visual Studio Code 或通过 命令行 中编辑、调试、运行 和 测试 你的脚本。

---

🔗 脚本的复用与分享

脚本就是 文件! 它们可以被版本控制、共享和分叉。

// 定义上下文
def("FILE", env.files, { endsWith: ".pdf" })
// 构建数据结构
const schema = defSchema("DATA", { type: "array", items: { type: "string" } })
// 分配任务
$`分析 FILE，并使用 ${schema} 模式将数据提取为 JSON。`

---

📋 数据模式

使用 模式 定义、验证和修复数据。内置 Zod 支持。

const data = defSchema("MY_DATA", { type: "array", items: { ... } })
$`使用 ${data} 模式从文件中提取数据。`

---

📄 从 PDF、DOCX 等中提取文本

操作 PDF、DOCX 等文件。

def("PDF", env.files, { endsWith: ".pdf" })
const { pages } = await parsers.PDF(env.files[0])

---

📊 从 CSV、XLSX 等中提取表格数据

处理来自 CSV、XLSX 等的表格数据。

def("DATA", env.files, { endsWith: ".csv", sliceHead: 100 })
const rows = await parsers.CSV(env.files[0])
defData("ROWS", rows, { sliceHead: 100 })

---

📝 生成文件

从 LLM 输出中提取文件并进行差异比较。在 Refactoring UI 中预览更改。

$`将结果保存到 poem.txt 中。`

FILE ./poem.txt
敏捷的棕狐跃过懒狗。

---

🔍 文件搜索

使用 grep 或模糊搜索 文件。

const { files } = await workspace.grep(/[a-z][a-z0-9]+/, { globs: "*.md" })

---

分类

对文本、图片或两者的混合进行分类。

const joke = await classify(
    "为什么鸡要过马路？为了在阳光下煎一煎。",
    {
        yes: "好笑",
        no: "不好笑",
    }
)

LLM 工具

将 JavaScript 函数注册为 工具，并提供对不支持工具的模型的回退机制。还支持 模型上下文协议 (MCP) 工具。

defTool(
    "weather",
    "查询天气 Web API",
    { location: "string" },
    async (args) =>
        await fetch(`https://weather.api.api/?location=${args.location}`)
)

---

LLM 代理

将 JavaScript 函数注册为 工具，并将工具与提示词结合形成代理。

defAgent(
    "git",
    "使用 Git 查询仓库以完成任务。",
    `你是一个有用的 LLM 代理，可以使用 git 工具查询当前仓库。
    回答 QUERY 中的问题。
    - 当前仓库与 GitHub 仓库相同。`,
    { model, system: ["system.github_info"], tools: ["git"] }
)

然后将其作为工具使用：

script({ tools: "agent_git" })

$`对最近的提交进行统计分析。`

参见 git 代理源码。

---

🔍 内置 RAG

向量搜索。

const { files } = await retrieval.vectorSearch("cats", "**/*.md")

---

🐙 GitHub 模型和 GitHub Copilot

通过 GitHub 模型 或 GitHub Copilot 运行模型。

script({ ..., model: "github:gpt-4o" })

---

💻 本地模型

使用 开源模型（如 Phi-3），通过 Ollama 或 LocalAI 运行你的脚本。

script({ ..., model: "ollama:phi3" })

---

🐍 代码解释器

让大语言模型在一个沙盒执行环境中运行代码。

script({ tools: ["python_code_interpreter"] })

---

🐳 容器

在 Docker 容器 中运行代码。

const c = await host.container({ image: "python:alpine" })
const res = await c.exec("python --version")

---

视频处理

对视频进行转录和截图，以便高效地将其输入到大语言模型的请求中。

// 转录
const transcript = await transcript("path/to/audio.mp3")
// 按片段截取屏幕截图
const frames = await ffmpeg.extractFrames("path_url_to_video", { transcript })
def("TRANSCRIPT", transcript)
def("FRAMES", frames)

🧩 大语言模型组合

运行大语言模型 来构建你的大语言模型提示。

for (const file of env.files) {
    const { text } = await runPrompt((_) => {
        _.def("FILE", file)
        _.$`总结 FILE。`
    })
    def("SUMMARY", text)
}
$`总结所有摘要。`

---

🅿️ Prompty 支持

也可以运行你的 Prompty 文件！

---
name: poem
---

给我写一首诗

---

可插拔的秘密扫描

使用 秘密扫描 扫描你的聊天内容中的敏感信息。

{
    "secretPatterns": {
        ...,
        "OpenAI API Key": "sk-[A-Za-z0-9]{32,48}"
    }
}

⚙ 使用 CLI 或 API 自动化

通过 CLI 或 API 实现自动化。

npx genaiscript run tlaplus-linter "*.tla"

import { run } from "genaiscript/api"

const res = await run("tlaplus-linter", "*.tla")

---

安全第一！

GenAIScript 提供内置的负责任 AI 系统提示以及 Azure 内容安全支持，以验证 内容安全。

script({ ...,
    system: ["system.safety_harmful_content", ...],
    contentSafety: "azure" // 使用 Azure 内容安全
})

const safety = await host.contentSafety()
const res = await safety.detectPromptInjection(env.vars.input)

---

💬 拉取请求评审

通过评论、评审或描述更新，将 GenAIScript 集成到你的 拉取请求检查 中。支持 GitHub Actions 和 Azure DevOps 流水线。

npx genaiscript ... --pull-request-reviews

---

⭐ 测试与评估

使用由 promptfoo 提供支持的 测试和评估，构建可靠的提示。

script({ ..., tests: {
  files: "penguins.csv",
  rubric: "is a data analysis report",
  facts: "The data refers about penguin population in Antarctica.",
}})

---

大语言模型友好的文档

整个文档的内容以 Markdown 格式渲染在 https://microsoft.github.io/genaiscript/llms-full.txt 上。可以直接将其输入到你喜爱的 RAG 系统中。

如果你是大语言模型爬虫，只需在任何文档 URL 后添加 .md 后缀，即可获取原始 Markdown 内容。例如，https://microsoft.github.io/genaiscript/guides/prompt-as-code.md（注意 .md 扩展名）。

贡献

我们欢迎贡献！请查看 CONTRIBUTING 页面，了解详细信息和开发者设置。

---

商标

该项目可能包含项目、产品或服务的商标或标识。微软商标或标识的授权使用须遵守并遵循 微软商标与品牌指南。在本项目的修改版本中使用微软商标或标识时，不得造成混淆或暗示微软的赞助关系。任何第三方商标或标识的使用均受该第三方政策的约束。

GenAIScript 快速上手指南

GenAIScript 是一个基于 JavaScript/TypeScript 的提示词编程工具箱，旨在通过代码编排大语言模型（LLM）、工具和数据处理流程。它支持无缝集成 Visual Studio Code 或命令行使用。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Windows, macOS, 或 Linux。
• Node.js：需安装 Node.js (推荐最新 LTS 版本)，以便运行脚本和管理依赖。
  • 检查版本：node -v
• 编辑器（可选但推荐）：Visual Studio Code，用于获得最佳的调试和编辑体验。
• 模型访问权限：您需要配置至少一个大模型提供商的 API Key（如 OpenAI, Azure OpenAI, Anthropic, GitHub Models）或本地模型环境（如 Ollama）。

安装步骤

您可以选择通过 VS Code 扩展或命令行工具进行安装。

方式一：安装 Visual Studio Code 扩展（推荐）

1. 打开 Visual Studio Code。
2. 进入扩展面板 (Ctrl+Shift+X 或 Cmd+Shift+X)。
3. 搜索 GenAIScript。
4. 点击 Install 安装由 Microsoft 发布的扩展。
5. 安装完成后，重启 VS Code 即可在侧边栏看到 GenAIScript 面板。

方式二：通过命令行安装

如果您更喜欢使用终端或通过 CI/CD 自动化运行，可以使用 npm/npx 安装 CLI 工具：

npx genaiscript@latest

或者全局安装：

npm install -g genaiscript

注意：国内用户若遇到 npm 下载缓慢，可临时切换至淘宝镜像源： npm config set registry https://registry.npmmirror.com

基本使用

GenAIScript 的核心概念是“提示词即代码”（Prompting is Coding）。您可以编写 .genai.mjs 或 .genai.ts 脚本来定义提示词逻辑。

1. 创建第一个脚本

在项目根目录下创建一个名为 hello.genai.mjs 的文件，并写入以下内容：

$`Write a 'hello world' poem.`

• $ 是一个模板标签函数，用于创建发送给 LLM 的提示词。
• 脚本运行后，会自动调用配置的模型生成一首关于 "hello world" 的诗。

2. 运行脚本

在 VS Code 中： 打开 hello.genai.mjs 文件，点击右上角的 Run 按钮（播放图标），输出结果将直接显示在终端或专用输出面板中。

在命令行中： 在项目目录下执行：

npx genaiscript run hello.genai.mjs

3. 进阶示例：处理文件与结构化输出

GenAIScript 擅长处理文件上下文和结构化数据。以下示例展示如何读取文件、将其内容注入提示词，并要求模型以 JSON 格式输出结果。

创建 analyze.genai.mjs：

// 读取工作区中的文本文件
const file = await workspace.readText("data.txt")

// 将文件内容定义为上下文变量 "DATA"
// GenAIScript 会自动优化长文本以适应模型上下文窗口
def("DATA", file)

// 构建提示词：分析数据并提取为 JSON
// 模型输出的 JSON 内容将被自动解析并保存
$`Analyze DATA and extract data in JSON in data.json.`

运行效果：

1. 脚本读取 data.txt。
2. 发送包含文件内容的提示词给 LLM。
3. LLM 返回分析结果，GenAIScript 自动识别其中的 data.json 代码块并将其保存为实际文件。

4. 配置模型

首次运行时，系统会提示您配置模型。您可以在 VS Code 的设置中或通过环境变量配置 API Key。例如，使用 GitHub Models 或 OpenAI：

// 在脚本头部指定模型（可选，默认使用全局配置）
script({ model: "github:gpt-4o" }) 
// 或者使用本地 Ollama 模型
// script({ model: "ollama:phi3" })

现在您已经完成了 GenAIScript 的基础设置，可以开始探索更强大的功能，如 RAG 检索、Agent 编排和本地容器执行了。