Agentforce Connector 1.0 リファレンス

このコネクタは、Salesforce の Agentforce プラットフォームで実行されている AI エージェントへの接続を提供します。

設定


設定

デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Name (名前)

String (文字列)

この設定の参照に使用される ID。

x

接続種別

OAuth Client Credentials (OAuth クライアントログイン情報)
パラメーター
名前 説明 デフォルト値 必須

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Client Id (クライアント ID)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアント ID。

x

Client Secret (クライアントシークレット)

String (文字列)

サービスプロバイダーに登録されている OAuth クライアントシークレット。

x

Token Url (トークン URL)

String (文字列)

サービスプロバイダーのトークンエンドポイント URL。

https://{salesforceorg}/services/oauth2/token

Scopes (スコープ)

String (文字列)

OAuth ダンス時に要求する OAuth スコープ。この値のデフォルトはアノテーションのスコープです。

Object Store (オブジェクトストア)

String (文字列)

各リソースオーナーのデータを保存するオブジェクトストアを設定します。設定されていない場合、Mule ではデフォルトのオブジェクトストアが使用されます。

操作

Continue Agent Conversation

<ms-agentforce:continue-agent-conversation>

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Message (メッセージ)

Any (任意)

#[payload]

Session Id (セッション ID)

String (文字列)

Start agent conversation​ 操作で返されるセッション ID。

x

Message Sequence Number (メッセージ連番)

Number (数値)

セッション内の後続のメッセージごとにこの数を増やします。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Error Mappings (エラーのマッピング)

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

次の設定の場合

スロー

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE​

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE​

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED​

End Agent Conversation

<ms-agentforce:end-agent-conversation>

End agent conversation​ 操作を使用して、エージェントが応答した後にセッションを閉じます。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Session Id (セッション ID)

String (文字列)

Start agent conversation​ 操作で返されるセッション ID。

#[payload]

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Error Mappings (エラーのマッピング)

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

次の設定の場合

スロー

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE​

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE​

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED​

Start Agent Conversation

<ms-agentforce:start-agent-conversation>

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

この操作で出力されるペイロードの MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

Streaming Strategy (ストリーミング戦略)

Mule によるストリームの処理方法を設定します。反復可能ストリームは、デフォルトの動作です。

Agent List (エージェントリスト)

String (文字列)

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力を評価する式。式の結果は対象変数に保存されます。

#[payload]

Error Mappings (エラーのマッピング)

エラーのマッピングのセット。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Type (型)

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • MS-AGENTFORCE:AGENT_METADATA_FAILURE​

  • MS-AGENTFORCE:AGENT_OPERATIONS_FAILURE​

  • MS-AGENTFORCE:CONNECTIVITY

  • MS-AGENTFORCE:RETRY_EXHAUSTED​

Unauthorize

<ms-agentforce:unauthorize>

特定のリソースオーナー ID のアクセストークン情報をすべて削除して、認証ダンスを再度実行しない限り、そのユーザー向けの操作を実行できないようにします。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Config Ref (設定参照)

ConfigurationProvider

このコンポーネントを実行するために使用する設定の名前。

x

次の設定の場合

Reconnection (再接続)

操作の再接続戦略を設定します。

項目 説明 デフォルト値 必須

Fails Deployment (デプロイメントに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

標準再接続戦略を設定し、再接続の頻度と、コネクタソースまたは操作で実行できる再接続の試行回数を指定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Count (数)

Number (数値)

Mule アプリケーションで実行できる再接続の試行回数。

Reconnect Forever (繰り返し再接続)

Mule アプリケーションが実行されている間はコネクタソースや操作によって指定された頻度で再接続が試行される Forever 再接続戦略を設定します。

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続を試行する頻度 (ミリ秒)。

Blocking (ブロック)

Boolean (ブール)

false​ の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

Invoke Agent Response Attributes (エージェント応答属性を呼び出す)

項目 説明 デフォルト値 必須

Messages (メッセージ)

Message (メッセージ)

項目 説明 デフォルト値 必須

Content Safe (コンテンツセーフ)

Boolean (ブール)

Feedback Id (フィードバック ID)

String (文字列)

Id

String (文字列)

Message (メッセージ)

String (文字列)

Plan Id (プラン ID)

String (文字列)

Reason (理由)

String (文字列)

Type (型)

String (文字列)

Repeatable In-Memory Stream (反復可能なメモリ内ストリーム)

データが最大バッファサイズを超えた場合に要求が失敗するメモリ内ストリーミング戦略を設定します。ユースケースで最適なバッファサイズは、必ずパフォーマンステストを実施して決めてください。

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

データストリームに割り当てるメモリの初期容量。ストリーミングされたデータがこの値を超える場合は、​[Buffer Size Increment (バッファサイズ増分)]​ の単位で ​[Max Buffer Size (最大バッファサイズ)]​ を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

バッファの最大サイズ。バッファサイズがこの値を超える場合、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。​0​ 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

[Initial Buffer Size (初期バッファサイズ)]​ 項目、​[Buffer Size Increment (バッファサイズ増分)]​ 項目、​[Max Buffer Size (最大バッファサイズ)]​ 項目の単位。

Repeatable File Store Stream (反復可能なファイルストアストリーム)

反復可能なファイルストアストリーミング戦略を設定します。この戦略では、ストリームコンテンツの一部がメモリ内に格納されます。ストリームのコンテンツが、設定されたバッファサイズよりも大きい場合、Mule はバッファのコンテンツをディスクにバックアップしてからメモリをクリアします。

項目 説明 デフォルト値 必須

In Memory Size (メモリ内サイズ)

Number (数値)

ストリームのデータで使用できるメモリの最大量。メモリ量がこの値を超えると、コンテンツはディスクにバッファされます。パフォーマンスを最適化する方法は、次のとおりです。

  • バッファサイズを大きくすると、Mule がバッファをディスクに書き込む回数を減らせます。これによってパフォーマンスが高まりますが、より多くのメモリが必要になるため、アプリケーションが処理できる同時要求数が制限されます。

  • バッファサイズを小さくすると、メモリの負荷は低減しますが、応答時間が長くなります。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

[In Memory Size (メモリ内サイズ)]​ 項目の単位。

Error Mappings (エラーのマッピング)

項目 説明 デフォルト値 必須

Source (ソース)

Enumeration (列挙)。次のいずれかになります。

  • ANY

  • REDELIVERY_EXHAUSTED​

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY​

  • SERVER_SECURITY​

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED​

  • TIMEOUT

Target (対象)

String (文字列)

x