Appearance
Outbound
Envelope の outbound は、その操作で Codatum がデータを外部へ送出した宛先を表します。 メールやチャットへの送信のように、Codatum の認可が及ばない宛先へデータが出た操作に付きます。
認証された操作者自身がデータを取得する操作には付きません。
outbound が付くかどうかは、イベントの種類ごとに決まっています。 ただし一部のイベントでは、外部への送出が起きなかった実行で付かないことがあります。 どちらになるかは各イベントページの outbound を参照してください。
result.status が deny や failure のイベントにも outbound は入ります。 実際には送出されなかった場合でも、どこへ送ろうとしたのかが分かるようにするためです。
送出した内容そのもの(本文や、データソースから取得したデータ)は記録しません。 何を送出したのかは、操作対象を表す resource と、 関連リソースを表す references からたどれます。
context との違い
経路と送出先は、データの向きで使い分けます。
context | outbound | |
|---|---|---|
| 向き | Codatum に入ってくる側 | Codatum から出ていく側 |
| 表すもの | 操作がどの経路から行われたか | 操作でデータがどこへ出たか |
context.mcp と outbound の mcp_server は、名前が似ていますが向きが逆です。 前者は Codatum の MCP サーバーへの接続を表し、後者は外部の MCP サーバーの呼び出しを表します。
宛先の種類
uid に入る値と、その取り扱いの注意は種類ごとに異なります。
type | uid | name | 注記 |
|---|---|---|---|
email | メールアドレス | — | sensitivity: pii |
slack | {team_id}/{channel_id} | チャンネル名 | — |
webhook | 送信先のオリジン | — | sensitivity: confidential |
llm | プロバイダの識別子、または codatum_managed | プロバイダの表示名 | モデル名は model に入ります |
mcp_server | サーバーのオリジン | サーバーの表示名 | sensitivity: confidential。ツール名は tool に入ります |
connector_api | エンドポイントのオリジン | コネクタの表示名 | sensitivity: confidential。アクション名は tool に入ります |
URL の宛先は、オリジン(https://ホスト名)までを記録します。 パス・クエリ文字列・フラグメント・認証情報は記録しません。 URL のどの部分が資格情報かは宛先のサービスによって異なり、パスに含む例もあるためです。
そのため、同じホスト上の別々の宛先は同じ uid になります。 どの設定から送出されたかは、resource と context から辿ってください。
llm の uid はプロバイダ単位です。 モデルを変更しても同じ宛先として集計できるようにするため、モデル名は uid に含めず、model が持ちます。
Codatum が管理するモデル(マネージドAIプロファイル)を経由した送出では、 プロバイダとモデルを Codatum が選定します。この場合の uid は codatum_managed で、 Codatum が選定した宛先を指します。name と model は入りません。 どのワークスペースでも、LLM へデータが出た事実は同じフィールドから読み取れます。
Objects
Outbound
その操作でデータを外部へ送出した宛先です。
宛先は targets に入ります。件数の上限を超えると切り詰められ、 切り詰められた場合は truncated が true になります。 切り詰めがなかった場合は truncated フィールド自体が付きません (ChangedField のフラグモードと同じ規約)。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
targets | OutboundTarget[] | 必須 | 送出先の一覧。1回の操作で複数の宛先へ送出した場合は、宛先ごとに1件ずつ入ります。outbound が付くイベントでは必ず1件以上入ります。 |
truncated | bool | 任意 | 件数の上限を超えて切り詰められた場合の true |
OutboundTarget
送出先1件分です。 種類(type)と、その種類ごとの識別子(uid)で宛先を表します。 種類ごとに何が入るかは 宛先の種類 を参照してください。
Reference とは別の型です。 Reference の uid が Codatum 内のリソースを指すのに対して、 OutboundTarget の uid は Codatum の外にある宛先を指します。
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
type | OutboundType | 必須 | 送出先の種類 |
uid | string | 必須 | 宛先の識別子。type によって入る値が変わります。利用者が設定した宛先では、Codatum が解決・検証しない外部の識別子が入ります。 Codatum が選定した宛先では、それを表す値が入ります。 |
name | string | 任意 | イベント発生時点の宛先の表示名。表示名を取得できる種類にのみ入ります。 |
model | string | 任意 | 送信先のモデル名。type が llm で、プロバイダとモデルを利用者が設定した場合に入ります。 |
tool | string | 任意 | 呼び出したツール・アクションの名前。type が mcp_server / connector_api のときに入ります。 |
Enums
OutboundType
送出先の種類です。
| 値 | 説明 |
|---|---|
email | メールアドレス宛の送信 |
slack | Slack のチャンネル宛の送信 |
webhook | 利用者が指定した URL 宛の送信 |
llm | LLM プロバイダへの送信 |
mcp_server | 外部の MCP サーバーの呼び出し |
connector_api | エージェントコネクタ経由の外部 API の呼び出し |