利用智能体 API 构建自定义 AI 智能体
学习目标
- 描述如何开始使用智能体 API。
- 使用智能体 API 开始与 AI 智能体的会话，并管理会话生命周期。
开始使用智能体 API
您是开发人员，负责将 Agentforce 集成到您的网站中，以便 Salesforce AI 智能体能够为您的客户提供快速且有帮助的问题响应。
您知道这将简化工作流程并提升用户交互体验，但该从何处着手？输入智能体 API。
让我们从更高层面逐步了解如何启动 Agentforce 并通过智能体 API 投入运行。
步骤 1：启用 Agentforce 并激活智能体
首先，您需要在 Salesforce 组织中启用 Agentforce。这是至关重要的一步，因为如果缺少这一步，后续的所有配置都将无法生效。启用 Agentforce 后，您需要激活至少一个智能体。
智能体 API 不支持类型为“Agentforce（默认）”的智能体。
步骤 2：创建外部客户端应用程序并启用 OAuth 设置
接下来，您需要在 Salesforce 中创建外部客户端应用程序。该应用程序处理客户端凭据流，这是安全 API 调用的关键环节。为 API 启用 Oauth 设置。
步骤 3：获取使用者密钥和使用者密码
应用程序设置完成后，您需要获取使用者密钥和使用者密码。这些凭据对于您的 API 调用身份验证至关重要。您可以在外部客户端应用程序中找到它们。
步骤 4：创建令牌
所有智能体 API 的调用都需要令牌。此令牌用于您的 API 调用身份验证。您可以利用使用者密钥、使用者密码和域名创建令牌。
亲身体验：发起您的首次 API 调用
现在进入激动人心的环节——调用智能体 API。
在调用之前，您需要从组织收集一些信息。要了解更多信息，请参阅智能体 API 开发人员指南中的调用 API。
通过命令行界面，运行此 curl 命令以使用智能体 API 创建新智能体会话。
curl --location -X POST https://api.salesforce.com/einstein/ai-agent/v1/agents/{AGENT_ID}/sessions \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--data '{
"externalSessionKey": "{RANDOM_UUID}",
"instanceConfig": {
"endpoint": "https://{MY_DOMAIN_URL}"
},
"streamingCapabilities": {
"chunkTypes": ["Text"]
},
"bypassUser": true
}'当此调用成功时，您将收到包含会话 ID 和附加信息的响应。这里有一个响应示例。
{
"sessionId": "80ab2e16-392e-4c12-b80a-f028a58400b5",
"_links": {
"self": null,
"messages": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages"
},
"messagesStream": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5/messages/stream"
},
"session": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/agents/0XxHr000000ysOSKAY/sessions"
},
"end": {
"href": "https://api.salesforce.com/einstein/ai-agent/v1/sessions/80ab2e16-392e-4c12-b80a-f028a58400b5"
}
},
"messages": [
{
"type": "Inform",
"id": "d27b7308-f1ab-47bd-949c-0225d5e21a8e",
"feedbackId": "",
"planId": "",
"isContentSafe": true,
"message": "Hi, I'm an AI service assistant. How can I help you?",
"result": [],
"citedReferences": []
}
]
}现在您可以开始向 AI 智能体发送消息。
智能体 API 同时支持同步和流消息处理。同步消息适用于需要在单次调用中获取完整响应的用例，而流消息更适合实时交互，例如聊天对话。
操作完成后，请记得关闭会话。
考虑事项
-
Data usage（数据使用）：智能体 API 的使用情况会影响信用额度消耗，具体说明详见生成式 AI 使用情况和计费。
-
API timeouts（API 超时）：智能体 API 的超时时间为 120 秒。如果调用超时，您将收到 HTTP 500 响应。
总结
好了。使用开始使用智能体 API 指南和示例代码，开始将 Agentforce 集成到您的网站，从而提升客户体验。