Table of Contents [expand]
この記事の英語版に更新があります。ご覧の翻訳には含まれていない変更点があるかもしれません。
最終更新日 2025年07月14日(月)
Heroku AppLink を使用すると、Heroku アプリの OpenAPI 仕様を Salesforce に公開し、アクションを生成できます。この記事では、Agentforce アクションの有効化など特定のアクションを有効にし、Salesforce で権限セットを定義するように OpenAPI 仕様を設定する方法について説明します。
Agentforce のトピックとアクションを有効にする
エージェントトピックには、Agentforce エージェントが実行できるアクションが含まれています。
アクションに対してトピックを有効にするには、以下の注釈を使用してトピックを定義する必要があります。トピックを 1 つ定義すると、アクションも 1 つ以上定義する必要があります。詳細は、「SF Topic and Action Enablement」(SF のトピックとアクションの有効化) を参照してください。
| 拡張機能 | 説明 |
|---|---|
x-sfdc/agent/topic/classificationDescription |
必須。トピックが何を実行するかを説明します。 |
x-sfdc/agent/topic/scope |
必須。トピックの境界を設定します。 |
x-sfdc/agent/topic/instructions |
必須。ガイドラインを設定して、そのトピックの文脈においてどのように会話を処理すべきかをエージェントに示します。 |
x-sfdc/agent/topic/name |
必須。トピックの API 名を設定します。スネークケースを使用して、先頭は文字で始め、英数字、スペース、アンダースコアを含めることをお勧めします。 |
API 操作を Agentforce エージェントアクションとして指定するには、1 つ以上の操作に対し、true に設定した x-sfdc/agent/action/publishAsAgentAction パラメータをアノテーションとして付加する必要があります。エージェントアクションには、その作成に必要なメタデータを指定するスキーマが必要です。このアノテーションにより、API がエージェントのトピックとアクションに対し有効になります。
| 拡張機能 | 説明 |
|---|---|
x-sfdc/agent/action/publishAsAgentAction |
必須。true に設定すると、操作がアクションとして有効になります。 |
x-sfdc/agent/action/isUserInput |
publishAsAgentAction が有効な場合は必須。true に設定すると、ユーザーが追加で入力できる項目が表示されます。 |
x-sfdc/agent/action/isDisplayable |
publishAsAgentAction が有効な場合は必須。true に設定すると、項目をユーザーに表示できるようになります。 |
x-sfdc/privacy/isPii |
任意。publishAsAgentAction が有効になっており、この属性が true である場合、その操作で送信されるクエリに対して PII サービスが有効になります。 |
以下は、エージェントのアクションとトピックを有効にする OpenAPI 仕様の例です。
openapi: 3.1.0
info:
title: Test API
version: '1.0'
x-sfdc:
agent:
topic:
classificationDescription: This API allows agents to book, modify, and cancel hotel reservations, as well as apply loyalty upgrades.
scope: Your job is to assist customers in booking hotel rooms based on their preferences, loyalty status, and availability. You should also be able to recommend upgrades if the customer qualifies.
instructions:
- If the customer asks to create a reservation, check for a check-in date, checkout date, roomType, or any special requests.
- If the preferred room type is unavailable, suggest alternative options with similar amenities.
paths:
/thing/{id}:
parameters:
- name: id
in: path
required: true
description: AI-friendly description
schema:
type: string
x-sfdc:
agent:
action:
isUserInput: true
get:
x-sfdc:
agent:
action:
publishAsAgentAction: true
operationId: get-a-thing
description: AI-friendly description
responses:
'200':
Heroku アプリの設定をカスタマイズする
必要に応じて、Salesforce で接続アプリまたは権限セットを定義して、ユーザーの権限をデフォルトの user モードから user-plus モードに昇格させることができます。
アプリの実行中に上位の権限を必要とするユーザーに、この指定された権限セットをアプリの標準権限セットと共に割り当てます。SDK が初期化されると、ユーザーの Salesforce 権限とこのセットの権限が組み合わされて DML 操作に適用されます。
| 拡張機能 | 説明 |
|---|---|
x-sfdc/heroku/authorization/connectedApp |
任意。使用する接続アプリの名前を設定します。指定されていない場合は、ユーザーモードに必要なユーザートークンを作成します。 注: x-sfdc/heroku/authorization/permissionSet を設定した場合、この拡張は必須です。 |
x-sfdc/heroku/authorization/permissionSet |
任意。ユーザー権限を昇格させるために使用する、セッションベースの権限セットを設定します。 |
以下は、使用する接続アプリと権限セットを指定する OpenAPI 仕様の例です。
openapi: 3.0.0
info:
...
paths:
/accounts:
get:
x-sfdc:
heroku:
authorization:
connectedApp: MyConnectedApp
permissionSet: MyPermSet