This is an automated email from the ASF dual-hosted git repository.
Lee-W pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new b96b5fdb058 Fix broken class references and truncated wording in
OpenAI provider docs (#69710)
b96b5fdb058 is described below
commit b96b5fdb0582e6b98a63f9cd894f0e23b237850c
Author: Wei Lee <[email protected]>
AuthorDate: Wed Jul 15 18:14:39 2026 +0800
Fix broken class references and truncated wording in OpenAI provider docs
(#69710)
---
providers/openai/docs/index.rst | 2 +-
providers/openai/docs/operators/openai.rst | 20 +++++++++-----------
providers/openai/provider.yaml | 2 +-
.../airflow/providers/openai/get_provider_info.py | 2 +-
4 files changed, 12 insertions(+), 14 deletions(-)
diff --git a/providers/openai/docs/index.rst b/providers/openai/docs/index.rst
index b39317fc48a..62677ba60ca 100644
--- a/providers/openai/docs/index.rst
+++ b/providers/openai/docs/index.rst
@@ -111,7 +111,7 @@ apache-airflow-providers-openai package
`OpenAI <https://platform.openai.com/docs/introduction>`__ provider for Apache
Airflow.
Enables interaction with OpenAI APIs for text generation, embeddings,
-and other AI-powered workflows directly from Airflow DAGs.
+and other AI-powered workflows directly from Airflow Dags.
Release: 1.8.0
diff --git a/providers/openai/docs/operators/openai.rst
b/providers/openai/docs/operators/openai.rst
index 61b10650ac0..bfb2fd8dee9 100644
--- a/providers/openai/docs/operators/openai.rst
+++ b/providers/openai/docs/operators/openai.rst
@@ -20,8 +20,8 @@
OpenAIEmbeddingOperator
========================
-Use the
:class:`~airflow.providers.open_ai.operators.open_ai.OpenAIEmbeddingOperator` to
-interact with Open APIs to create embeddings for given text.
+Use the
:class:`~airflow.providers.openai.operators.openai.OpenAIEmbeddingOperator` to
+interact with the OpenAI API to create embeddings for given text.
Using the Operator
@@ -30,7 +30,7 @@ Using the Operator
The OpenAIEmbeddingOperator requires the ``input_text`` as an input to
embedding API. Use the ``conn_id`` parameter to specify the OpenAI connection
to use to
connect to your account.
-An example using the operator is in way:
+An example of using the operator:
.. exampleinclude:: /../../openai/tests/system/openai/example_openai.py
:language: python
@@ -89,20 +89,18 @@ For example, to create a conversation and continue it
across responses:
OpenAITriggerBatchOperator
===========================
-Use the
:class:`~airflow.providers.open_ai.operators.open_ai.OpenAITriggerBatchOperator`
to
-interact with Open APIs to trigger a batch job. This operator is used to
trigger a batch job and wait for the job to complete.
+Use the
:class:`~airflow.providers.openai.operators.openai.OpenAITriggerBatchOperator`
to
+interact with the OpenAI API to trigger a batch job. This operator is used to
trigger a batch job and wait for the job to complete.
Using the Operator
^^^^^^^^^^^^^^^^^^
-The OpenAITriggerBatchOperator requires the prepared batch file as an input to
trigger the batch job. Provide the ``file_id`` and the ``endpoint`` to trigger
the batch job.
-Use the ``conn_id`` parameter to specify the OpenAI connection to use to
+The OpenAITriggerBatchOperator requires the prepared batch file as an input to
trigger the
+batch job. Provide the ``file_id`` and the ``endpoint`` to trigger the batch
job, and use the
+``conn_id`` parameter to specify the OpenAI connection to use.
-
-The OpenAITriggerBatchOperator
-
-An example using the operator is in way:
+An example of using the operator:
.. exampleinclude::
/../../openai/tests/system/openai/example_trigger_batch_operator.py
:language: python
diff --git a/providers/openai/provider.yaml b/providers/openai/provider.yaml
index cd6e6c862cf..9a41cdb4e82 100644
--- a/providers/openai/provider.yaml
+++ b/providers/openai/provider.yaml
@@ -23,7 +23,7 @@ name: OpenAI
description: |
`OpenAI <https://platform.openai.com/docs/introduction>`__ provider for
Apache Airflow.
Enables interaction with OpenAI APIs for text generation, embeddings,
- and other AI-powered workflows directly from Airflow DAGs.
+ and other AI-powered workflows directly from Airflow Dags.
state: ready
lifecycle: production
diff --git a/providers/openai/src/airflow/providers/openai/get_provider_info.py
b/providers/openai/src/airflow/providers/openai/get_provider_info.py
index 47b5bba24f7..3f9ff71b5d6 100644
--- a/providers/openai/src/airflow/providers/openai/get_provider_info.py
+++ b/providers/openai/src/airflow/providers/openai/get_provider_info.py
@@ -25,7 +25,7 @@ def get_provider_info():
return {
"package-name": "apache-airflow-providers-openai",
"name": "OpenAI",
- "description": "`OpenAI
<https://platform.openai.com/docs/introduction>`__ provider for Apache
Airflow.\nEnables interaction with OpenAI APIs for text generation,
embeddings,\nand other AI-powered workflows directly from Airflow DAGs.\n",
+ "description": "`OpenAI
<https://platform.openai.com/docs/introduction>`__ provider for Apache
Airflow.\nEnables interaction with OpenAI APIs for text generation,
embeddings,\nand other AI-powered workflows directly from Airflow Dags.\n",
"integrations": [
{
"integration-name": "OpenAI",
