From dd81bf60e969f12b7406a26196ecc9aff57abe05 Mon Sep 17 00:00:00 2001 From: Jason Date: Wed, 16 Aug 2023 21:12:41 -0700 Subject: [PATCH] last clean up before pypi --- README.md | 17 ----------------- pyproject.toml | 4 ++-- 2 files changed, 2 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 3600afa..42d3749 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,6 @@ This library is built to interact with openai's function call api from python code, with python structs / objects. It's designed to be intuitive, easy to use, but give great visibily in how we call openai. -The approach of combining a human prompt and a "response schema" is not necessarily unique; however, it shows great promise. As we have been concentrating on translating user intent into structured data, we have discovered that Python with Pydantic is exceptionally well-suited for this task. - -**OpenAISchema** is based on Python type annotations, and powered by Pydantic. - -The key features are: - -* **Intuitive to write**: Great support for editors, completions. Spend less time debugging. -* **Writing prompts as code**: Collocate docstrings and descriptions as part of your prompting. -* **Extensible**: Bring your own kitchen sink without being weighted down by abstractions. - -## Structured Extraction with `openai` - -Welcome to the Quick Start Guide for OpenAI Function Call. This guide will walk you through the installation process and provide examples demonstrating the usage of function calls and schemas with OpenAI and Pydantic. - ### Requirements This library depends on **Pydantic** and **OpenAI** that's all. @@ -34,9 +20,6 @@ This library depends on **Pydantic** and **OpenAI** that's all. To get started with OpenAI Function Call, you need to install it using `pip`. Run the following command in your terminal: -!!! note Requirement - Ensure you have Python version 3.9 or above. - ```sh $ pip install instructor ``` diff --git a/pyproject.toml b/pyproject.toml index 1ebfc53..ce8b7d9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] -name = "openai-function-call" -version = "0.2.3" +name = "instructor" +version = "0.2.4" description = "Helper functions that allow us to improve openai's function_call ergonomics" authors = ["Jason "] license = "MIT"