Inferable 开源项目教程

1. 项目介绍

Inferable 是一个用于创建带有人机交互的可靠 AI 工作流的托管型持久执行运行时环境。它允许用户创建结构化输出，并通过 Slack 或 Email 向人类请求审批，同时支持版本化的长运行工作流以保证向后兼容性。

Inferable 的主要特点包括：

• 在用户自己的基础设施中执行工作流，甚至可以在防火墙后或私有 VPC 中运行。
• 支持版本化工作流，以便逐步推出新版本，同时保持当前运行工作流的版本亲和性。
• 集成人类审批和干预，完整保留上下文信息。
• 自动解析和验证结构化输出，并重试失败的执行。

2. 项目快速启动

首先，确保您的开发环境已经准备好 Node.js。以下是快速启动 Inferable 的步骤：

# 克隆项目
git clone https://github.com/inferablehq/inferable.git

# 进入项目目录
cd inferable

# 安装依赖
npm install

# 启动服务
npm start

启动服务后，您可以通过浏览器访问本地服务来查看 Inferable 的管理控制台。

3. 应用案例和最佳实践

以下是使用 Inferable 的一些典型应用案例：

人机审批工作流

const deleteUserWorkflow = inferable.workflows.create({
  name: 'deleteUser',
  inputSchema: z.object({
    userId: z.string(),
  }),
});

deleteUserWorkflow.version(1).define(async (ctx, input) => {
  // ...现有工作流代码...
  if (!ctx.approved) {
    return Interrupt.approval({
      message: `我需要您的批准来删除用户 ${input.userId}。这样可以吗？`,
      destination: {
        type: 'email',
        email: '[e-mail]',
      },
    });
  }
  await db.customers.delete({
    userId: input.userId,
  });
});

结构化输出

workflow.version(1).define(async (ctx, input) => {
  const { ticketType } = ctx.llm.structured({
    input: `票证文本:
${input.ticketText}`,
    schema: z.object({
      ticketType: z.enum(['data-deletion', 'refund', 'other']),
    }),
  });
  // 使用结构化输出
  console.log(ticketType);
});

4. 典型生态项目

Inferable 支持多种语言的 SDK，以下是一些生态项目：

• Node.js / TypeScript SDK：用于在 Node.js 或 TypeScript 项目中集成 Inferable。
• Go SDK：用于在 Go 项目中集成 Inferable。
• .NET SDK（实验性）：用于在 .NET 项目中集成 Inferable。

通过这些 SDK，开发者可以更容易地在自己的项目中实现 Inferable 的功能。