Lee-W commented on code in PR #72051:
URL: https://github.com/apache/airflow/pull/72051#discussion_r4015796958
##########
providers/openai/src/airflow/providers/openai/operators/openai.py:
##########
@@ -138,43 +138,59 @@ class OpenAITriggerBatchOperator(BaseOperator):
"""
Operator that triggers an OpenAI Batch API endpoint and waits for the
batch to complete.
- :param file_id: Required. The ID of the batch file to trigger.
- :param endpoint: Required. The OpenAI Batch API endpoint to trigger.
+ :param file_id: Required. The ID of the batch file to trigger. (templated)
+ :param endpoint: Required. The OpenAI Batch API endpoint to trigger.
(templated) Allowed values
+ are determined by the OpenAI Batch API; see
+ :meth:`~airflow.providers.openai.hooks.openai.OpenAIHook.create_batch`.
:param conn_id: Optional. The OpenAI connection ID to use. Defaults to
'openai_default'.
:param deferrable: Optional. Run operator in the deferrable mode.
:param wait_seconds: Optional. Number of seconds between checks. Only used
when ``deferrable`` is False.
Defaults to 3 seconds.
:param timeout: Optional. The amount of time, in seconds, to wait for the
request to complete.
- Only used when ``deferrable`` is False. Defaults to 24 hour, which is
the SLA for OpenAI Batch API.
+ Applies in both deferrable and non-deferrable mode. Defaults to 24
hours, which is the SLA for
+ OpenAI Batch API.
:param wait_for_completion: Optional. Whether to wait for the batch to
complete. If set to False, the operator
will return immediately after triggering the batch. Defaults to True.
+ :param metadata: Optional. A set of key-value pairs that can be attached
to the batch. (templated)
+ :param completion_window: Optional. The time window for the batch to
complete. Defaults to 24 hours,
+ the only value OpenAI currently accepts.
+ :param poll_interval: Optional. Number of seconds between checks. Only
used when ``deferrable`` is True.
+ Defaults to 60 seconds.
.. seealso::
For more information on how to use this operator, please take a look
at the guide:
:ref:`howto/operator:OpenAITriggerBatchOperator`
"""
- template_fields: Sequence[str] = ("file_id",)
+ template_fields: Sequence[str] = ("file_id", "endpoint", "metadata")
Review Comment:
Added `template_fields_renderers = {"metadata": "json"}`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
