本文へスキップ
すべてのツール

recipe_run

スキルとレシピ · macOS · Windows

効果: 実行. 状態: 条件付き提供.

「条件付き提供」は、バージョン、プラットフォーム、権限、アカウント、設定に依存する可能性を示し、すべての環境で有効という意味ではありません。

macOS

目的

レシピを最初から最後まで実行します。パラメーターをバインドし、レジストリ経由で各ステップのツールを順に実行し、実行結果を保存し(recipe_runs を参照)、各ステップの結果と、あれば markers_path を返します。状態を変更するステップ(書き込み/送信/削除)を含むレシピは、最初にプレビューを返します。実行するには confirm:true を付けてもう一度呼び出してください。読み取り専用のレシピは直ちに実行されます。この確認は実行を開始するだけで、それ以外は何も許可しません。ステップ自身が確認することはできません。ステップの args にある `confirm` は無視され(プレビューと実行レポートで、そのステップに confirm_ignored が付きます)、自身で確認を求めるツールのステップは、プレビューを返すだけで実行されません(実行レポートでは previewed と記録され、previewed_steps に一覧されます)。その操作を行うには、そのツールを直接実行してください。エラーになったステップ(応答内のエラー、または拒否)は実行を停止し、報告されます(stopped_at と、そのステップの error_key)。この Mac が tools/list で提供していないツールのステップは拒否されます(tool_not_advertised)。どちらも、そのステップに "optional": true が付いていない限り実行を停止します。付いている場合は、エラーがそのステップの結果と skipped_optional に記録され、実行は続行されます。

必須入力

入力名はツールが要求する正確な形式のままです。英語の正規技術定義は下の展開可能なスキーマにあります。

権限と確認

スキーマには明示的な確認パラメータがあります。プレビューを確認し、プラットフォーム契約に従って実操作を承認してください。

英語の正規技術スキーマ — macOS
{
  "properties": {
    "confirm": {
      "description": "Set true to execute a recipe that has state-changing steps; read-only recipes ignore it.",
      "type": "boolean"
    },
    "name": {
      "description": "Name of the saved skill (recipe) to run, exactly as recipe_list reports it.",
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

ドキュメント例

recipe_run のドキュメント例です。この例は実行しないでください。表示される引数は架空のデータセットに属します。実際に呼び出す前に実在する識別子を確認し、承認を得てください。

{
  "confirm": false,
  "name": "Demo morning brief"
}

Windows

目的

保存済みのレシピを最初から最後まで実行します。パラメーターをバインドし、各ステップのツールを順に実行し、実行を記録し(recipe_runs を参照)、各ステップの結果を返します。確認ゲート: confirm:true がない場合は、バインドされた引数付きの、順序どおりのステップのDRY-RUN プレビューを返します。実行するには confirm:true を付けてもう一度呼び出してください。エラーになったステップは実行を停止し、報告されます(stopped_at)。ただし、そのステップに "optional": true が付いている場合は、エラーがそのステップの結果と skipped_optional に記録され、実行は続行されます。ステップ自身が確認することはできません。ステップの引数にある confirm は無視され(ステップに confirm_ignored が付きます)、確認を求めるツール(送信、削除、ファイルの置き換え、コマンドの実行)のステップは、そのツールのプレビューを返すだけで、何も変更しません。変更を行うには、ユーザーが承認したあとで、そのツールを直接呼び出してください。

必須入力

入力名はツールが要求する正確な形式のままです。英語の正規技術定義は下の展開可能なスキーマにあります。

権限と確認

スキーマには明示的な確認パラメータがあります。プレビューを確認し、プラットフォーム契約に従って実操作を承認してください。

英語の正規技術スキーマ — Windows
{
  "properties": {
    "confirm": {
      "description": "Set true to execute; without it a dry-run preview is returned.",
      "type": "boolean"
    },
    "name": {
      "description": "Recipe name (from recipe_list).",
      "type": "string"
    },
    "params": {
      "description": "Param overrides (merged over the recipe defaults).",
      "type": "object"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

ドキュメント例

recipe_run のドキュメント例です。この例は実行しないでください。表示される引数は架空のデータセットに属します。実際に呼び出す前に実在する識別子を確認し、承認を得てください。

{
  "confirm": false,
  "name": "Demo morning brief"
}