NeboAI
NeboAI
はじめる

トリガー

トリガーは、ワークフローがいつ実行されるかを決めます。Neboには7種類のトリガーがあります。それぞれ、typeフィールドとその種類用のフィールドを持つオブジェクトです。

種類実行されるタイミング
schedulecron式に一致したとき。
heartbeat一定の間隔が経過したとき。任意で毎日の時間帯の中に限定できます。
event一致するソースのイベントが発行されたとき。
watchプラグインの監視役が出力を1行書き出したとき。
folderフォルダ内のファイルが変わったとき。
manualオーナーまたは社員が実行したとき。
call電話回線に着信があったとき。電話の応答ツリーでのみ使えます。

schedule

{ "type": "schedule", "cron": "0 8 * * 1-5", "schedule": "Weekdays at 8:00" }

cronは5つのフィールドからなるcron式です: 分、時、日、月、曜日。scheduleは人向けの任意の説明です。スケジュールはボットの現地のタイムゾーンで実行されます。Neboは5秒ごとにスケジュールを確認します。ボットがオフの間に逃した発火は、遅れが1時間未満なら一度だけ取り戻されます。前の実行がまだ続いている間は、発火はスキップされます。

heartbeat

{ "type": "heartbeat", "interval": "30m", "window": "08:00-18:00" }

intervalは30m、1h、2h30mのような期間です。window(HH:MM-HH:MM)を指定すると、発火を勤務時間内に収められます。次の発火は前回の発火に間隔を足した時刻で、時間帯の中に移されます。最初の発火は、ワークフローの読み込みから1間隔後です。タイマーは再起動後も保たれます。前の実行がまだ続いている間は発火がスキップされ、無効な間隔は一度も発火しません。

event

{ "type": "event", "sources": ["support-coordinator.summary.ready", "assignment.*"] }

sourcesには、完全一致、または末尾の.*ワイルドカードで照合するイベント名を列挙します。空のリストはエラーで、agent.json全体が拒否されます。実行は_event_source、_event_payload、_event_originを受け取ります。名前の付け方についてはイベントをご覧ください。

watch

{ "type": "watch", "plugin": "mail", "event": "email.new" }

ウォッチは、プラグインのプロセスを動かし続け、それが書き出す行ごとに実行を開始します。各行は_watch_payloadとして届きます。10分以内の同一の行は破棄されます。

フィールドデフォルト意味
plugin必須mailのような機能、またはプラグインのスラッグ。当てはまる機能があれば、必ず機能を指定してください。
eventなしプラグインのeventsリストにあるイベント。Neboはそのイベントのコマンドを使い、各行を<plugin>.<event>としても発行します。
commandなし監視役を起動する引数。設定されていればそれを使い、なければeventから取得します。
restart_delay_secs5終了した監視役を再起動するまでの待ち時間。

機能は、それを提供するインストール済みのプラグインに解決されます。この社員がアカウントを持っているものが優先されます。該当するプラグインがない場合、ワークフローは機能低下として表示され、何をつなぐべきかがオーナーに伝えられます。クラッシュを繰り返す監視役は、倍々に延びて最大300秒になる遅延を置いて再起動し、30秒間動き続けると遅延がリセットされます。

{ "type": "watch", "plugin": "notes-sync", "command": "watch --notebook {{notebook}} --format ndjson" }

command 内の {{key}} は、社員の入力に対するオーナーの回答で埋められます。回答のないプレースホルダーがあると、監視は開始されません。

folder

{ "type": "folder", "path": "{{inbox_folder}}", "extensions": ["pdf"], "recursive": false }
フィールドデフォルト意味
path必須フォルダの絶対パス。{{key}}は入力から埋められます。
extensionsすべてのファイル照合するファイル拡張子(ドットなし)。
recursivetrueサブフォルダを含める。
debounce_secs2この時間内の変更は1回の実行にまとめられます。

実行は、変更されたパスを_watch_payload.filesで受け取ります。

manual

{ "type": "manual" }

手動のワークフローは、オーナーが実行するか、社員がrun_workflowを呼び出したときにだけ実行されます。トリガーの種類にかかわらず、どのワークフローもこの方法で実行できます。

call

{"type": "call", "line": "..."} は、社員が電話回線にどう応答するかを設定する "type": "call_tree" のワークフロー内でのみ有効です。line が空の場合、社員が応答する回線のうち、より具体的なツリーがないすべての回線に適用されます。コールツリーには、あいさつがちょうど1つと、名前付きのインテントが少なくとも1つ必要です。

Webhook

オーナーは社員用のWebhookを作成することもできます。ワークフローにひも付いたWebhookはそのワークフローを実行し、ワークフローのないWebhookはペイロードを社員のチャットに届けます。