diff --git a/airflow-core/docs/tutorial/hitl.rst b/airflow-core/docs/tutorial/hitl.rst index cc6a76b5ef1ec..ab5c6ed0175b2 100644 --- a/airflow-core/docs/tutorial/hitl.rst +++ b/airflow-core/docs/tutorial/hitl.rst @@ -190,3 +190,12 @@ Benefits and Common Use Cases HITL functionality is valuable in large language model (LLM) workflows, where human-provided guidance can be essential for achieving better results. It is also highly beneficial in enterprise data pipelines, where human validation can complement and enhance automated processes. + +See also +-------- + +* `Standard provider HITL operators documentation + `_ + +* `HITL operators Python API reference + `_ diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 3aa45ba8fed5b..b96510805a0a7 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -820,6 +820,8 @@ healthjump heartrate heatmap Highcharts +HITL +hitl hivecmd hiveconf hiveconfs diff --git a/providers/standard/docs/operators/hitl.rst b/providers/standard/docs/operators/hitl.rst new file mode 100644 index 0000000000000..837dca55d1170 --- /dev/null +++ b/providers/standard/docs/operators/hitl.rst @@ -0,0 +1,44 @@ + .. Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + .. http://www.apache.org/licenses/LICENSE-2.0 + + .. Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +Human in the Loop (HITL) Operators +================================== + +Human-in-the-Loop (HITL) operators enable workflows where task execution +can pause and wait for human input, approval, or intervention before +continuing. + +These operators are part of the ``apache-airflow-providers-standard`` +package and are intended for modeling approval steps or manual decision +points within automated pipelines. + +Available HITL operators +------------------------ + +The Standard provider includes Human-in-the-Loop (HITL) operators. +For the complete and up-to-date list of available operators and their +parameters, refer to the Python API documentation: + +`Python API reference `_ + +Usage guide +----------- + +For an end-to-end guide on using HITL operators, including examples and +recommended patterns, see the HITL tutorial: + +* `HITL tutorial `_