GPT's function calling feature wrapper
Project description
CallingGPT
GPT's Function Calling - the proof-of-concept.
Read this guide before you start: function-calling
Abstract
OpenAI's GPT models provide a function calling feature, so we can easily create ChatGPT-Plugins-like
tools. This repository is a proof-of-concept of the function calling feature.
In this experiment, we defined the Plugin
as Namespace
which contains a serial of functions. While user performing a conversation, the functions in Namespace
will be called by the API and return the result to the user.
Usage
-
Clone this repository and install the dependencies.
git clone https://github.com/RockChinQ/CallingGPT cd CallingGPT pip install -r requirements.txt
-
Run the
main.py
to generateconfig.yaml
python main.py
-
Edit the
config.yaml
to set your API key and other settings. -
Run the
main.py
and pass your modules.python main.py <module0> <module1> ...
Example
Use the example/greet.py
python main.py example/greet.py
Then you can talk to the bot.
$ python main.py examples/greet.py
Using module: examples.greet
>>> hello and who are you?
<<< Hello! I am an AI assistant here to help you. How may I assist you today?
>>> say hello to Rock
func<examples.greet.greet>: Hello, Rock!
>>> and to Alice
func<examples.greet.greet>: Hello, Alice!
>>>
For Code
-
Install the package
pip install --upgrade CallingGPT
-
Create your own functions in modules(these modules can also be used in the CLI mode)
# your_module_a.py def func_a(prompt: str) -> str: # Type hint of EACH argument and return value is REQUIRED. """ The description of this func a, will be provided to the api. Args: prompt(str): The prompt of the function. Returns: The result of the function. """ # Google style docstring is REQUIRED, it will be split into `description` and `params`(required if there are args) and `returns`(optional), `\n\n` between each part. return "func_a: " + prompt
# your_module_b.py def adder(a: int, b: int) -> int: """ Add two numbers. Args: a: The first number. b: The second number. Returns: The sum of a and b. """ # Type hints of args in docstring is optional. return a + b
-
Call the wrapper
from CallingGPT.session.session import Session import your_module_a, your_module_b session = Session([your_module_a, your_module_b]) session.ask("your prompt")
Session
will automatically manage context for you.
Project details
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
Built Distribution
Hashes for CallingGPT-0.0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2590a54b2bac7cc6ac5846207b0c86aae85fc6cae1030800bff0b3ab7a4999b9 |
|
MD5 | 9967fd10ff56c279acd646490a19a883 |
|
BLAKE2b-256 | 2dfb25c419179eee08ace2b0601f06f53f04f9c1a26ba9916d9413b426e28e5b |