Skip to content

Latest commit

 

History

History
66 lines (54 loc) · 2.22 KB

README.md

File metadata and controls

66 lines (54 loc) · 2.22 KB
Raw

openai

Welcome to the Go client bindings library and CLI for the OpenAI API! With this tool, you can interact with the OpenAI API from your Go projects and command line.

Some of the things you can do with the CLI include:

  • List OpenAI models
  • Moderate text
  • Edit images
  • Generate images from text
  • Edit text
  • Generate text
  • Create variations of images from text

This README and the source code for this project were created with the help of GitHub Copilot and an AI language model trained by OpenAI.

Features

  • Image API support for generating images, variations, and edits
  • Models API support for listing models
  • Moderation API support for moderating text
  • Uses the remote OpenAI API

Requirements

  • Go 1.18 or newer
  • spf13 cobra library
  • OPENAI_API_KEY: To get an API key, follow these steps:
    • Go to the OpenAI website (https://openai.com/) and click on the "Sign Up" button in the top right corner of the page.
    • Fill out the sign up form with your name, email address, and password, and click the "Sign Up" button.
    • You will receive a confirmation email. Click on the link in the email to confirm your account.
    • Once you have confirmed your account, log in to the OpenAI website.
    • In the top right corner of the page, click on your user name, then select "API Key" from the dropdown menu.
    • Click the "Generate API Key" button.
    • Your API key will be displayed on the page. Copy the API key and use it as the value for the OPENAI_API_KEY environment variable.

Examples

Create an image:

go run cmd/openai.go help image image create "Pretty woman walking down the street."

Create image variations:

go run cmd/openai.go image variations testdata/image.png -n 2

Create image edits:

go run cmd/openai.go image edits testdata/image.png "A winter forest with a winding path." -m testdata/mask.png -n 2

Edit text:

go run cmd/openai.go edit -a "What day of thet wek is it?" -s "Fix the spelling mistakes"

Moderate text:

go run cmd/openai.go moderation -i "Would you come over to have coffee together?"

List models:

go run cmd/openai.go models

License

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