Skip to content

Fix broken class references and truncated wording in OpenAI provider docs #69710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
Lee-W wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −14
Draft

Fix broken class references and truncated wording in OpenAI provider docs #69710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion providers/openai/docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 9 additions & 11 deletions providers/openai/docs/operators/openai.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion providers/openai/provider.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion providers/openai/src/airflow/providers/openai/get_provider_info.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down