A short wrapper of the OpenAI api call.
Project description
中文文档移步这里。
Openai API call
A simple wrapper for OpenAI API, which can send prompt message and return response.
Installation
pip install openai-api-call --upgrade
Note: Since version
0.2.0,Chattype is used to handle data, which is not compatible with previous versions.
Usage
Set API Key
import openai_api_call
openai_api_call.api_key = "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Or set OPENAI_API_KEY in ~/.bashrc to automatically set it when you start the terminal:
# Add the following code to ~/.bashrc
export OPENAI_API_KEY="sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
Set Proxy (Optional)
from openai_api_call import proxy_on, proxy_off, proxy_status
# Check the current proxy
proxy_status()
# Set proxy(example)
proxy_on(http="127.0.0.1:7890", https="127.0.0.1:7890")
# Check the updated proxy
proxy_status()
# Turn off proxy
proxy_off()
Basic Usage
Example 1, send prompt and return information:
from openai_api_call import Chat, show_apikey
# Check if API key is set
show_apikey()
# Check if proxy is enabled
proxy_status()
# Send prompt and return response
chat = Chat("Hello, GPT-3.5!")
resp = chat.getresponse(update=False) # Not update the chat history, default to True
Example 2, customize the message template and return the information and the number of consumed tokens:
import openai_api_call
# Customize the sending template
openai_api_call.default_prompt = lambda msg: [
{"role": "system", "content": "帮我翻译这段文字"},
{"role": "user", "content": msg}
]
chat = Chat("Hello!")
# Set the number of retries to Inf
# The timeout for each request is 10 seconds
response = chat.getresponse(temperature=0.5, max_requests=-1, timeout=10)
print("Number of consumed tokens: ", response.total_tokens)
print("Returned content: ", response.content)
Advanced Usage
Continue chatting based on the last response:
# first call
chat = Chat("Hello, GPT-3.5!")
resp = chat.getresponse() # update chat history, default is True
print(resp.content)
# continue chatting
chat.user("How are you?")
next_resp = chat.getresponse()
print(next_resp.content)
# fake response
chat.user("What's your name?")
chat.assistant("My name is GPT-3.5.")
# print chat history
chat.print_log()
License
This package is licensed under the MIT license. See the LICENSE file for more details.
update log
- Since version
0.2.0,Chattype is used to handle data - Since version
0.3.0, you can use different API Key to send requests.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openai_api_call-0.3.2.tar.gz
(7.8 kB
view hashes)
Built Distribution
Close
Hashes for openai_api_call-0.3.2-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5d4721b50ef9f53f8f9e31528ad4b18020861653db83b46ffaa3dd0cc1e5a825 |
|
| MD5 | 7a1f5d310bc3336279b75a1be43cb2e3 |
|
| BLAKE2b-256 | 06b2abc1ea69172d9531f7493bb6aeee672590a0ab65531823f158761757bab8 |
