Lee-W commented on code in PR #69590: URL: https://github.com/apache/airflow/pull/69590#discussion_r3542380710
########## providers/openai/docs/quickstart.rst: ########## @@ -0,0 +1,86 @@ + .. 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. + +.. _howto/quickstart: + +Quick start +=========== + +Go from zero to a generated model response in three steps: install the +provider, configure a connection, and write a Dag. + +1. Install +---------- + +.. code-block:: bash + + pip install apache-airflow-providers-openai + +2. Configure the connection +---------------------------- + +Every call goes through an OpenAI connection (``conn_type`` ``openai``, +default connection id ``openai_default``). Specify your OpenAI API key in +the password field. See :ref:`howto/connection:openai` for the full +reference, including workload identity authentication (Kubernetes, Azure, +GCP, or a custom token provider) if you'd rather exchange short-lived +identity tokens than store a long-lived API key. + +The quickest way to set one up is an environment variable: + +.. code-block:: bash + + export AIRFLOW_CONN_OPENAI_DEFAULT='{"conn_type": "openai", "password": "sk-..."}' + +Or add it through the Airflow UI (``Admin > Connections``) or the CLI (``airflow connections add``). + +3. Write your first Dag +------------------------ + +The :class:`~airflow.providers.openai.operators.openai.OpenAIResponseOperator` +generates a model response with the OpenAI Responses API and returns the +response's aggregated output text: + +.. code-block:: python + + from airflow.sdk import dag Review Comment: didn't notice we still support 2.11. Also confirmed in the provider `pyproject.toml`. instead of making it part of the doc, i extract it as an example Dag and added a comment for the compat thing. -- 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]
