kennethreitz/instructor
1
0
Fork 0
mirror of https://github.com/kennethreitz/instructor.git synced 2026-06-05 22:50:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

clean readme

Browse Source
This commit is contained in:
Jason
2023-06-23 13:02:39 +08:00
parent d4c94daa2c
commit 6df94576df
1 changed files with 13 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -10
View File
@@ -1,11 +1,18 @@
# OpenAI Function Call and Pydantic Integration Module
# Pydantic is all you need: An OpenAI Function Call Pydantic Integration Module
This Python module provides a powerful and efficient approach to output parsing when interacting with OpenAI's Function Call API. It leverages the data validation capabilities of the Pydantic library to handle output parsing in a more structured and reliable manner. This README will guide you through the installation, usage, and contribution processes of this module.
We try to provides a powerful and efficient approach to output parsing when interacting with OpenAI's Function Call API. One that is framework agnostic and minimizes any dependencies. It leverages the data validation capabilities of the Pydantic library to handle output parsing in a more structured and reliable manner.
If you have any feedback, leave an issue or hit me up on [twitter](https://twitter.com/jxnlco).
This repo also contains a range of examples I've used in experimetnation and in production and I welcome new contributions for different types of schemas.
## Installation
```python
pip install openai_function_call
```
## Contributing
To get started, clone the repository
```bash
@@ -18,13 +25,6 @@ Next, install the necessary Python packages from the requirements.txt file:
pip install -r requirements.txt
```
## Contributing
Your contributions are welcome! If you have great examples or find neat patterns, clone the repo and add another example.
The goal is to find great patterns and cool examples to highlight.
If you encounter any issues or want to provide feedback, you can create an issue in this repository. You can also reach out to me on Twitter at @jxnlco.
### Poetry
We also use poetry if you'd like
@@ -33,7 +33,10 @@ We also use poetry if you'd like
poetry build
```
Note that there's no separate pip install command for this module. Simply copy and paste the module's code into your application.
Your contributions are welcome! If you have great examples or find neat patterns, clone the repo and add another example.
Check out the issues for any ideas if you want to learn. The goal is to find great patterns and cool examples to highlight.
If you encounter any issues or want to provide feedback, you can create an issue in this repository. You can also reach out to me on Twitter at @jxnlco.
## Usage