Flow オブジェクト
Flow オブジェクト
Flow オブジェクトには、フローの状態が含まれます。実際には、次の 3 つの部分で構成されています。
- 実行する必要のあるタスクと、それらの依存関係およびパラメーター。
- タスクの状態 (完了、待機中、または失敗)。
- タスクとアクション間のやり取りに使用されるプロパティ バッグ。
Flow リソースによって返されるオブジェクトは、次のプロパティによって Flow オブジェクトをラップします。
| 名前 | 型 | 説明 |
|---|---|---|
| self | リンク | この Flow リソースへのリンク |
| flow | オブジェクト | 実際の Flow オブジェクト |
実際の Flow オブジェクト
実際の Flow オブジェクトには、次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| tasks | オブジェクト | すべての Task オブジェクトのディクショナリを保持します。これらの全タスクが完了または失敗した時点で、この Flow が完了したとみなされます。 |
| properties | オブジェクト | アクションおよびタスクが読み書きし、情報を渡すための、すべてのプロパティを含めたプロパティ バッグを保持します。 |
| completed_tasks | 配列 | 完了したタスクの名前を保持します。 |
| waiting_tasks | 配列 | サードパーティ サービスからの結果を待機しているタスクの名前を保持します。 |
| failed_tasks | オブジェクト | 失敗したすべてのタスクが含まれるディクショナリと、キャプチャされたエラー メッセージを保持します。 |
ファイル データはファイル プロバイダーによって処理され、ファイル キーはプロパティ バッグ内のプロパティとしてやり取りされます。
Task オブジェクト
Task オブジェクトには、次のプロパティがあります。
| 名前 | 型 | 説明 |
|---|---|---|
| type | 文字列 | このタスクの処理を担当するタスク ハンドラーの名前。 |
| deps | 配列 | 任意。このタスクが依存しているタスクの名前。このタスクは、すべての依存タスクが完了するまで処理されません。依存タスクのいずれかが失敗した場合、このタスクは自動的に失敗します。 |
| do_yield | ブール値 | (任意) このタスクが完了した後、エージェントがフローを生成して、他のエージェントが続行できるようにするかどうかを指定します。 |
| do_update | ブール値 | (任意) このタスクが完了した後、次のタスクに進む前に、中間状態のフローに対してエージェントがオーケストレータ－を更新するかどうかを指定します。 |
Task オブジェクトのその他のプロパティは、Task タイプに応じてパラメーターとして使用します。