Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
phelps-sg authored Nov 13, 2023
1 parent a611b31 commit 32a839b
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,12 @@
![GitHub release (latest by date)](https://img.shields.io/github/v/release/phelps-sg/openai-pygenerator)
![GitHub](https://img.shields.io/github/license/phelps-sg/openai-pygenerator?color=blue)

This is a simple type-annotated wrapper around the OpenAI Python API which provides retry functionality, reduces the default timeout from 10 minutes to 20 seconds (configurable), and provides a generator over completions. In addition to providing a simple class to manage chat session state, it can also be used to chain together completions from different prompts in a very straightforward [functional-programming](https://docs.python.org/3/howto/functional.html) style using [Python generators](https://docs.python.org/3/howto/functional.html#generators).
This is a simple type-annotated wrapper around the OpenAI Python API which provides:
- retry functionality,
- reduces the default timeout from 10 minutes to 20 seconds (configurable), and
- provides a generator over completions.

In addition to providing a simple class to manage chat session state, it can also be used to chain together completions from different prompts in a very straightforward [functional-programming](https://docs.python.org/3/howto/functional.html) style using [Python generators](https://docs.python.org/3/howto/functional.html#generators).

## Installation

Expand Down

0 comments on commit 32a839b

Please sign in to comment.