Skip to content

The Flask-OpenAI extension seamlessly integrates OpenAI's powerful AI functionalities into Flask applications, enabling developers to easily leverage OpenAI's API for generating text, code, and more within their web projects.

License

Notifications You must be signed in to change notification settings

level09/flask-openai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flask-OpenAI Extension

The Flask-OpenAI extension provides a simple and intuitive way to integrate OpenAI's API into your Flask applications. With minimal setup, you can start leveraging the power of AI models in your Flask projects, whether it's for generating text, code, or any other application supported by OpenAI.

Features

  • Easy integration of OpenAI's API into Flask applications.
  • Automatic management of OpenAI API keys.
  • Efficient handling of API client instances throughout the application lifecycle.

Installation

Install Flask-OpenAI using pip:

pip install flask-openai

Quick Start

  1. Set up your Flask application

First, ensure you have Flask installed. If not, you can install it using pip:

pip install Flask

Then, set up a basic Flask application:

from flask import Flask
app = Flask(__name__)
  1. Configure the Flask-OpenAI extension

Import and initialize the OpenAI extension, passing your Flask app object to it. Don't forget to set the OPENAI_API_KEY in your app's configuration:

from flask_openai import OpenAI

app.config['OPENAI_API_KEY'] = 'your_openai_api_key_here'
openai_extension = OpenAI(app)

Alternatively, if you are using a factory function to create your Flask app, you can set up the OpenAI extension like this:

openai_extension = OpenAI()

def create_app():
    app = Flask(__name__)
    app.config['OPENAI_API_KEY'] = 'your_openai_api_key_here'
    openai_extension.init_app(app)
    return app
  1. Use the OpenAI client in your application

Now, you can access the OpenAI client in your route handlers using openai_extension.client. Here's an example of how to generate text with the OpenAI API:

@app.route('/generate-text')
def generate_text():
    completion = openai.client.chat.completions.create(
        model="gpt-3.5-turbo",
        messages=[
            {"role": "system",
             "content": "You are a poetic assistant, skilled in explaining complex programming concepts with creative flair."},
            {"role": "user", "content": "Compose a poem that explains the concept of recursion in programming."}
        ]
    )

    return completion.choices[0].message.content

Documentation

For more information on OpenAI's API and its capabilities, visit OpenAI API documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a pull request.

Support

If you have any questions or encounter any issues, please open an issue on the project's GitHub page.

Acknowledgements

This project is not officially associated with OpenAI. All trademarks are the property of their respective owners.

About

The Flask-OpenAI extension seamlessly integrates OpenAI's powerful AI functionalities into Flask applications, enabling developers to easily leverage OpenAI's API for generating text, code, and more within their web projects.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages