NeboAI
NeboAI
はじめる

ワークフロー

ワークフローとは、社員が頼まれなくてもこなす仕事です。朝のまとめ、新着メッセージへの返信、週次レポートなどです。各ワークフローは、トリガーと、社員が実行するアクティビティを組み合わせます。ワークフローは社員のagent.jsonに記述されるので、役割と一緒に持ち運べます。

最初のワークフロー

agent.jsonにworkflowsマップを追加します。各キーがワークフローの名前になり、各値がトリガーとアクティビティを持ちます。

{
  "workflows": {
    "morning-summary": {
      "trigger": { "type": "schedule", "cron": "0 8 * * 1-5" },
      "description": "Summarize yesterday's open conversations every weekday morning.",
      "activities": [
        { "id": "summarize", "intent": "Summarize yesterday's open customer conversations and what each one is waiting on." }
      ]
    }
  }
}

このワークフローは、ボットの現地時間で平日の08:00に実行されます。社員は、自分のペルソナ、スキル、接続を使ってアクティビティを実行します。

ワークフローのフィールド

フィールド意味
trigger必須。ワークフローを実行するタイミング。「トリガー」を参照してください。
descriptionワークフローの目的。
activities手順。「アクティビティ」を参照してください。
connectionsアクティビティをグラフにするエッジ{from, to, label}。__trigger__が開始、__emit__が終了です。
emitこのワークフローが終了時に告知するイベント: リスト、またはカンマ区切りの1つの文字列。「イベント」を参照してください。
inputsすべての実行に渡される値。
budget{total_per_run, cost_estimate}。グラフでの実行ではtotal_per_runが出力トークンの上限になり、それ以外ではどちらも見積もりです。
caseワークフローを、人や物ごとに1つの長期にわたるケースにします。「ケース」を参照してください。

トリガーがあってアクティビティのないワークフローも有効です。アクティビティのないウォッチは、そのイベントを他のワークフローに中継するだけです。

実行の仕組み

connectionsがない場合、アクティビティは順番に実行され、社員がそれぞれを行います。各アクティビティの結果は次に渡されます。出力のないアクティビティがあると、実行は終了します。

connectionsがある場合、アクティビティはグラフを形づくります。分岐は並行して実行され、6種類のアクティビティはモデルを使わずに実行されます: condition、loop、wait、http、command、decide。振り分けを厳密にする必要があるときはグラフを使ってください。

{
  "trigger": { "type": "watch", "plugin": "mail", "event": "email.new" },
  "activities": [
    { "id": "classify", "type": "decide",
      "params": {
        "questions": {
          "kind": {
            "type": "choice",
            "instructions": "What kind of message is this?",
            "criteria": { "invoice": "A bill from a vendor", "other": "Anything else" }
          }
        },
        "default": { "kind": "other" }
      } },
    { "id": "is-invoice", "type": "condition", "params": { "expression": "nodes.classify.kind.choice == invoice" } },
    { "id": "record", "intent": "Record the invoice in _watch_payload as a bill and note the due date." }
  ],
  "connections": [
    { "from": "__trigger__", "to": "classify" },
    { "from": "classify", "to": "is-invoice" },
    { "from": "is-invoice", "to": "record", "label": "True" },
    { "from": "record", "to": "__emit__" }
  ],
  "emit": ["invoice.recorded"]
}

実行が受け取るもの

社員は常に、自分のペルソナと、inputsの質問に対するオーナーの回答を持っています。実行は、トリガーに応じて次の値も受け取ります。

入力存在する条件
_event_source, _event_payload, _event_originイベントトリガーが発火した場合。8 KB以上のペイロードはスカラーのフィールドだけに短縮され、メールのヘッダーと添付ファイルの参照は保持されます。
_watch_payloadウォッチまたはフォルダのトリガーが発火した場合。監視役の出力の1行、またはフォルダの場合は{files}。
inputs常に。ワークフロー自身のinputsの値。

ケース

数日にわたる仕事もあります。フォローアップが必要な見込み客や、書類を待っている依頼などです。caseを追加すると、ワークフローは毎回新しく始める代わりに、人や物ごとに1つのケースを開いたままにします。

フィールド意味
key必須。対象を識別する、トリガーデータへのカンマ区切りのドット記法のパス(contactEmail,email,phoneなど)。
typeleadのようなケースの種類。同じ種類のワークフローはケースを共有します。デフォルトはワークフロー名です。
default_waitターンで待ち時間を指定しなかったときに待つ長さ: 3d、12h、45m。デフォルトは3日。

ケースの各ターンは、1つのJSONオブジェクトで終わり、その後には何も置けません。resultは業務上の状態で、nextはエンジンにwaitするかcloseするかを伝えます。期限はRFC 3339形式か相対的な期間です。それ以外は無効なターンになります。

{"result": {"status": "awaiting_documents", "summary": "Requested two bank statements"},
 "next":   {"action": "wait", "on": "signal", "deadline": "3d", "reason": "documents"}}

上限と復旧

  • 各アクティビティは、params.maxIterationsで別に指定しない限り、最大50回のモデルのターンを使えます。
  • グラフでは、1つのアクティビティは1回の実行につき最大10,000回まで実行できます。
  • オーナーが社員に設定した支出上限に達すると、実行は停止します。アクティビティのtoken_budgetは見積もりです。
  • 再起動で中断された実行は、中断済みとしてマークされ、一度だけ再開されます。
  • 社員はexitツールで実行を早めに終えることができます。

ワークフローの実行と管理

オーナーはどのワークフローも手動で実行できます。社員はrun_workflow、workflow_status、list_workflow_runs、set_workflow_enabled、そしてヘルパーとチームに記載のその他のワークフロー用ツールでワークフローを管理します。