Get Started 开始使用 ¶
1. 什么是Wordware？ ¶
Wordware是一个强大的AI代理构建和管理平台，它让用户能够轻松地构建、测试、协作和部署基于AI的应用程序（称为WordApps）。Wordware的核心是围绕"提示"（prompt）概念构建的，提示可以是文本、图像、音频（未来还将支持视频）等内容，用于指导AI生成内容。
2. Wordware的主要功能 ¶
- 流程编辑器：可视化构建AI应用的工作流
- AI生成：利用先进的AI模型生成内容
- 部署能力：将你的流程部署为独立的应用
- API支持：通过API集成到现有系统中
- 自动化工作流：与Zapier集成，实现自动化
- 协作功能：团队共同编辑和管理项目
3. 开始使用Wordware ¶
3.1 编辑器界面介绍 ¶
Wordware的编辑器是你构建、测试和部署AI应用的中心。编辑器界面主要包括：
- 流程面板：中央区域显示当前正在编辑的流程
- 导航栏：顶部包含运行、共享、部署等操作按钮
- 文件面板：左侧管理你的流程和文件夹
在编辑器中，你可以通过键入/并输入节点名称来添加新节点。对于纯文本内容，你可以直接开始输入。
3.2 创建第一个流程 ¶
- 点击左侧的
files按钮，打开文件面板 - 点击
New flow按钮创建新流程 - 在编辑器中输入你的提示（任何你输入的内容都是提示）
- 使用
/添加特殊节点（如生成节点、循环节点等） - 点击右上角的
Run按钮（或使用键盘快捷键CTRL+R或CMD+R）执行流程
3.3 理解节点系统 ¶
Wordware中的内容被划分为节点，按照它们在流程中的顺序（从上到下，从左到右）运行。一些节点（如if-else和循环节点）可以包含其他节点，形成分支或重复的执行路径。
主要节点类型： ¶
- 生成节点：使用AI生成内容
- 结构化生成节点：生成符合特定结构的内容
- 循环节点：重复执行内部内容
- 代码执行节点：运行JavaScript或Python代码
- If-Else节点：条件分支控制
- 输入节点：获取用户输入
- 触发器节点：响应特定事件触发流程
- 工具节点：调用外部工具和API
4. 部署和分享 ¶
4.1 部署为WordApp ¶
将你的流程部署为独立的WordApp，可以与任何人分享，或嵌入到你自己的网站或应用中：
- 点击导航栏上的"Share"按钮
- 选择"Public"（公开）或"Private"（私有，仅对组织成员可见）
- 点击"Deploy"开始部署
- 在部署页面查看你的新应用，查看API文档，或设置预填充的输入
每次部署的版本都有自己的URL和ID，你可以控制在不同场景使用哪个版本。
4.2 管理版本 ¶
Wordware使用简化的语义版本控制，所有版本都遵循<major>.<minor>格式（例如1.0）。你可以使用脱字符语法（如^1.0）获取最新的次要版本。
5. API集成 ¶
5.1 获取API密钥 ¶
- 点击右上角的用户头像
- 选择"API Keys"
- 生成新的API密钥
5.2 调用API ¶
部署应用后，你可以通过API访问它。API端点格式为：
https://app.wordware.ai/api/released-app/<app_id>/run
请求体示例： ¶
{
"inputs": {
"text": "<文本值>",
"image": {
"type": "image",
"image_url": "<图片URL>"
},
"audio": {
"type": "audio",
"audio_url": "<音频URL>"
}
},
"version": "^1.0"
}
认证 ¶
在请求头中使用你的API密钥进行认证：
Authorization: Bearer <API_KEY>
5.3 Python实现示例 ¶
import json
import requests
def main():
app_id = "YOUR_APP_ID"
api_key = "YOUR_API_KEY"
# 执行提示
r = requests.post(f"https://app.wordware.ai/api/released-app/{app_id}/run",
json={
"inputs": {
"topic": "人工智能",
# 图像输入需要公开可访问的URL
"image": {
"type": "image",
"image_url": "https://example.com/image.jpg",
},
},
"version": "^1.0"
},
headers={"Authorization": f"Bearer {api_key}"},
stream=True
)
# 确保请求成功
if r.status_code != 200:
print("请求失败，状态码", r.status_code)
print(json.dumps(r.json(), indent=4))
else:
for line in r.iter_lines():
if line:
content = json.loads(line.decode('utf-8'))
value = content['value']
# 实时打印生成内容
if value['type'] == 'generation':
if value['state'] == "start":
print("\n新生成 -", value['label'])
else:
print("\n生成结束 -", value['label'])
elif value['type'] == "chunk":
print(value['value'], end="")
elif value['type'] == "outputs":
# 查看最终输出
print("\n最终输出:")
print(json.dumps(value, indent=4))
if __name__ == '__main__':
main()
5.4 JavaScript/TypeScript实现示例 ¶
const API_KEY = "YOUR_API_KEY";
const appId = "YOUR_APP_ID";
async function main() {
console.log("运行应用", appId);
// 运行提示，流式传输生成内容
const r = await fetch(
`https://app.wordware.ai/api/released-app/${appId}/run`,
{
method: "post",
body: JSON.stringify({
inputs: {
topic: "人工智能",
// 图像输入需要公开可访问的URL
image: {
type: "image",
image_url: "https://example.com/image.jpg",
},
},
version: "^1.0",
}),
headers: {
Authorization: `Bearer ${API_KEY}`,
},
}
);
if (!r.ok) {
console.error("运行失败", await r.json());
throw Error(`运行失败 ${r.status}`);
}
const reader = r.body.getReader();
const decoder = new TextDecoder();
let buffer = [];
try {
while (true) {
const { done, value } = await reader.read();
if (done) {
return;
}
const chunk = decoder.decode(value);
for (let i = 0, len = chunk.length; i < len; ++i) {
const isChunkSeparator = chunk[i] === "\n";
// 除非到达数据块末尾，否则继续缓冲
if (!isChunkSeparator) {
buffer.push(chunk[i]);
continue;
}
const line = buffer.join("").trimEnd();
// 这是数据块
const content = JSON.parse(line);
const value = content.value;
// 打印流式生成内容
if (value.type === "generation") {
if (value.state === "start") {
console.log("\n新生成 -", value.label);
} else {
console.log("\n生成结束 -", value.label);
}
} else if (value.type === "chunk") {
process.stdout.write(value.value ?? "");
} else if (value.type === "outputs") {
console.log(value);
}
buffer = [];
}
}
} finally {
reader.releaseLock();
}
}
main();
6. 自动化工作流 ¶
Wordware与Zapier集成，使你能够创建自动化工作流，将WordApp与数千个其他应用连接起来。
6.1 创建工作流 ¶
- 部署应用后，导航到应用的"Deployments"页面中的"Workflows"选项卡
- 点击"New Workflow"按钮创建新工作流
- 这将打开集成的Zapier编辑器，在这里你可以构建任何Zapier支持的工作流
6.2 配置触发器 ¶
在Zapier编辑器中，选择触发你想要启动工作流的触发器。例如：
- 定时触发（Schedule）
- 表单提交触发
- 电子邮件触发
- 等等
6.3 连接WordApp ¶
- 点击触发器下方的操作卡，打开操作菜单
- 搜索并选择Wordware作为你想要的应用
- 选择"run app"作为你想要的操作事件
- 使用你的API密钥进行认证
- 选择你想要运行的WordApp和版本
- 如果你的应用需要任何输入，你可以在输入字段中添加它
6.4 使用WordApp输出 ¶
你可以将WordApp的输出用于其他Zapier操作：
- 添加一个新步骤到你的工作流
- 选择你想要使用WordApp输出的应用
- 在配置部分，填写必需的输入字段
- 要引用WordApp的输出，输入反斜杠
/或点击输入字段旁的+按钮 - 选择你之前的WordApp，然后选择该WordApp的任何输出
6.5 发布工作流 ¶
测试工作流成功后，点击"Publish"按钮实时部署工作流。工作流现在会根据你的触发器配置自动运行。
7. 最佳实践与技巧 ¶
7.1 流程组织 ¶
- 小项目可以在单个流程中管理
- 大型项目可能需要分解为多个流程
- 使用文件夹组织你的流程
- 命名要清晰明了，方便协作
7.2 提示工程 ¶
- 确保提示清晰明确
- 使用适当的例子指导AI输出
- 考虑边缘情况和错误处理
- 利用系统提示设置整体指令
7.3 部署策略 ¶
- 频繁部署以测试变更
- 使用版本控制管理不同环境（开发、测试、生产）
- 为演示目的设置预填充输入
7.4 API使用 ¶
- 安全存储API密钥
- 实现错误处理和重试机制
- 考虑使用缓存减少API调用
- 实现流式传输以提供更好的用户体验
8. 示例项目 ¶
以下是你可以用Wordware构建的一些项目示例：
8.1 客户服务聊天机器人 ¶
使用生成节点和循环节点创建一个可以回答常见问题的聊天机器人，并在需要时将对话升级给人类。
8.2 内容创建助手 ¶
构建一个可以生成博客文章、社交媒体帖子或产品描述的助手，根据简短的输入提示生成高质量内容。
8.3 数据分析工具 ¶
结合代码执行节点和生成节点，创建一个可以分析数据并生成可读报告的工具。
8.4 知识库查询系统 ¶
连接外部数据源，允许用户以自然语言查询公司内部文档或知识库。
9. 常见问题解答 ¶
问：Wordware免费版和付费版有什么区别？
答：免费账户的提示默认是公开的，而付费用户可以随时通过点击导航栏右侧的锁定图标将其设为私有。
问：我可以在Wordware中使用自己的AI模型吗？
答：文档中没有明确说明这一点，建议联系Wordware团队了解更多关于自定义模型集成的信息。
问：Wordware支持哪些编程语言？
答：Wordware支持JavaScript和Python代码执行节点，让你可以在流程中运行自定义代码。
问：Wordware如何处理敏感数据？
答：建议查阅Wordware的隐私政策，并使用私有部署选项处理敏感数据。
问：我可以将Wordware集成到现有应用中吗？
答：是的，你可以通过API调用将Wordware集成到现有应用中，或使用嵌入功能将WordApp嵌入到你的网站或应用。
10. 获取更多帮助 ¶
- 文档：访问Wordware文档获取详细信息
- Discord社区：加入Wordware Discord与其他用户和开发人员交流
- 专家指导：预约与Wordware专家的通话获取个性化指导
- 模板：探索Wordware提供的预构建模板，快速开始项目