AI助手SDK

Pillar是一个开源的AI助手SDK,可嵌入到SaaS应用中,通过执行任务(如导航页面、预填表单和调用API)来帮助用户完成操作。

  • by pillarhq
  • Python
  • 本地部署
  • 40 星标
  • 更新于
在 GitHub 查看 pillarhq/pillar

使用说明

Pillar is an open-source AI copilot SDK for SaaS — a product assistant that executes tasks, not just answers questions

Docs · Blog · Website · Discord · Twitter


支柱

开源产品副产品。将AI代理构建到您的应用程序中,执行任务,而不仅仅是回答问题。

支柱 是一个可嵌入的AI副驾驶SDK。用户说他们想要什么,Pillar使用你的UI来实现它——导航页面、预填写表单和调用你的API。它与用户的会话一起在客户端运行,因此没有代理服务器或令牌转发。

Pillar适用于SaaS和web应用程序。用户可能会问:

银行应用程序: “给我的清洁工寄200美元”

客户关系管理: “完成沃尔玛交易并通知执行”

分析仪表板: “将每周注册图表添加到我的仪表板”

PM工具: “为此结账崩溃创建一个P1错误,并将其添加到此sprint中”

Pillar理解意图,构建一个多步骤计划,并使用您的UI执行它——就像用户一样,但不用动手。

此存储库包含Pillar平台:后端API和管理仪表板。SDK包是单独维护的——请参阅 sdk, sdk-react,以及 sdk-vue.


为什么选择Pillar?

  • 一次安装,完全属于你: npm install 然后走。定义操作、自定义UI和行为——所有这些都在你自己的代码中。没有黑盒子。
  • 行动,而不仅仅是答案:导航页面、预填表单、调用API。助手代表用户做事情,而不仅仅是解释如何做。
  • 客户端执行:在用户的浏览器中与会话一起运行。相同的身份验证,没有代理服务器,没有令牌转发。
  • 管理知识:抓取您的文档并与您的内容源(网站、文件、云存储和片段)集成。RAG自动保持新鲜。
  • 包括MCP服务器:符合标准的MCP和WebMCP支持允许您通过Pillar连接顶级模型和代理工作流。
  • 多框架SDK:React、Vue、Angular和vanilla JS。所有麻省理工学院授权,免费嵌入专有应用程序。

快速开始

云(最快)

注册地址: 台虫网 得到你的 Slug探员,然后安装SDK:

npm install @pillar-ai/react

1.将提供商添加到您的应用程序中:

import { PillarProvider } from '@pillar-ai/react';

function App() {
  return (
    <PillarProvider agentSlug="your-agent-slug">
      <YourApp />
    </PillarProvider>
  );
}

2.使用注册工具 usePillarTool:

工具让人工智能助手在你的应用程序中执行任务——导航到页面、打开模态、调用API。为您的工具定义创建挂钩文件:

// hooks/usePillarTools.ts
import { usePillarTool } from '@pillar-ai/react';
import { useRouter } from 'next/navigation';

export function usePillarTools() {
  const router = useRouter();

  usePillarTool({
    name: 'open_settings',
    type: 'navigate',
    description: 'Navigate to the settings page',
    examples: ['open settings', 'go to settings'],
    autoRun: true,
    execute: () => router.push('/settings'),
  });

  usePillarTool({
    name: 'add_to_cart',
    type: 'trigger_tool',
    description: 'Add a product to the shopping cart',
    inputSchema: {
      type: 'object',
      properties: {
        productId: { type: 'string', description: 'The product ID to add' },
        quantity: { type: 'number', description: 'Number of items to add' },
      },
      required: ['productId', 'quantity'],
    },
    execute: async ({ productId, quantity }) => {
      await cartApi.addItem(productId, quantity);
    },
  });
}

从您的内部组件调用钩子 PillarProvider:

import { usePillarTools } from './hooks/usePillarTools';

function App() {
  usePillarTools();
  return <div>{/* your app */}</div>;
}

工具在组件装载时自动注册,在卸载时自动注销。

3.将工具同步到Pillar:

CLI扫描您的代码库以查找 usePillarTool 调用工具定义并将其同步到Pillar。构建应用程序后,在CI/CD中运行此命令:

PILLAR_SLUG=your-product-slug PILLAR_SECRET=your-secret-token npx pillar-sync --scan ./src

将slug和secret占位符替换为您的值 仪表盘.Point --scan 在包含工具定义的目录中。

这 execute 函数在应用程序的客户端运行。用户现在可以要求副驾驶导航到设置或将商品添加到购物车中,并使用您的代码执行。

自托管

git clone https://github.com/pillarhq/pillar.git
cd pillar
cp backend/.env.example backend/.env
# Edit backend/.env with your API keys
docker compose up

API运行在端口8000上,管理面板运行在端口3000上。看 自我寄宿 有关配置详细信息。


特性

功能 描述
工具 导航页面、预填表单、调用API——助手执行,而不仅仅是解释 文档
知识库 从网站、文件、云存储(S3/GCS)和片段中摄取 文档
AI 聊天 基于文档的流式、上下文感知响应 文档
定制卡片 渲染交互式UI,用于在聊天中内联确认和数据输入 文档
人类升级 移交给Intercom、Zendesk、Freshdesk或自定义支持流程 文档
MCP 服务器 通过Pillar为顶级模型和代理工作流提供符合标准的MCP和WebMCP支持
管理仪表盘 管理来源、审查分析、配置代理行为和主题化

探索中的所有功能 文档.


软件开发工具包

所有SDK包都是MIT许可的,可以自由嵌入到专有应用程序中。源代码位于独立的存储库中 github/pillarhq.

框架 包 安装 指南
反应 @pillar-ai/react npm install @pillar-ai/react React快速入门
查看 @pillar-ai/vue npm install @pillar-ai/vue Vue快速入门
角度 @pillar-ai/angular npm install @pillar-ai/angular Angular快速入门
香草JS @pillar-ai/sdk npm install @pillar-ai/sdk Vanilla JS快速入门

或者通过CDN加载,无需构建步骤:

<script src="https://cdn.trypillar.com/sdk.js"></script>
<script>
  Pillar.init({ agentSlug: 'your-agent-slug' });
</script>

看 React API参考 和 核心SDK参考 API完整文档。


建筑

backend/          Django API, RAG pipeline, MCP server, Hatchet workflows
frontend/         Next.js admin dashboard

SDK在单独的存储库中维护: sdk, sdk-react, sdk-vue.

堆栈: Django+DRF、PostgreSQL+pgvector、Redis、Hatchet(工作流编排)、Next.js、TypeScript


自我寄宿

先决条件

  • Docker和Docker Compose
  • 至少一个人工智能提供商API密钥(OpenAI、Anthropic或Google)
  • A. 斧头 后台工作流的实例(云或自托管)

设置

git clone https://github.com/pillarhq/pillar.git
cd pillar
cp backend/.env.example backend/.env
# Edit backend/.env with your API keys and configuration
docker compose up

API在端口8000上运行,管理面板在端口3000上运行。看 backend/.env.example 对于所有配置选项。

有关本地开发设置,请参阅 贡献指南.


开源vs云

开源 云
部署 自托管 管理地点 台虫网
基础设施 你管理 我们管理
更新 手动 自动
许可证 AGPL-3.0 基于使用量的定价
支持 社区 优先支持
特性 全平台 全平台+托管基础设施

托管版本位于 台虫网 这是最简单的开始方式。无需管理基础设施,始终保持最新状态。

对于需要自行托管而不承担AGPL义务的企业,可以使用商业许可证。联系 support@trypillar.com.


资源


贡献

我们欢迎捐款!请阅读我们的 贡献指南 在提交pull请求之前。


许可证

该项目采用双许可模式:

  • AGPL-3.0 核心产品(后端+前端)。如果修改Pillar并将其作为服务运行,则必须在AGPL-3.0下发布修改。从您的应用程序中使用Pillar的API不会触发此义务。
  • 麻省理工学院 对于中的SDK包 packages/。您可以自由地将这些嵌入到您的专有应用程序中。

看 许可证 完整的AGPL-3.0文本。第三方依赖关系详细信息请参见 backend/pyproject.toml 和 frontend/package.json.


负责任的使用: 用户在使用Pillar的抓取功能时有责任遵守网站的政策。Pillar默认尊重robots.txt。