https://github.com/liteobject/demo-openai-api
Learn OpenAI API
https://github.com/liteobject/demo-openai-api
open-ai openai pthon3 python
Last synced: about 1 month ago
JSON representation
Learn OpenAI API
- Host: GitHub
- URL: https://github.com/liteobject/demo-openai-api
- Owner: LiteObject
- Created: 2024-02-02T03:15:21.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-03T21:53:23.000Z (almost 2 years ago)
- Last Synced: 2024-12-29T18:21:55.489Z (about 1 year ago)
- Topics: open-ai, openai, pthon3, python
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Demo OpenAI API
## Create a virtual python environment
- `virtualenv -p python3.11 env_name`
- `python -m venv env_name`
---
## Create a file listing all required dependencies of the Python project
pip freeze > requirements.txt
## Install dependencies from requirements.txt:
pip install -r requirements.txt
---
## How to create an assistant/agent
### High Level Components
```mermaid
flowchart LR
A(1. Assustant/Agent)
--> T(2. Thread)
--> M(3. Message)
--> R(4. Run)
```
### Code Example
```python
# Create an assitant
assistant = client.beta.assistants.create(
name="Math Tutor",
instructions="You are a personal math tutor. Write and run code to answer math questions.",
tools=[{"type": "code_interpreter"}],
model="gpt-4-1106-preview",
)
# Create a thread
thread = client.beta.threads.create()
# Create a message
message = client.beta.threads.messages.create(
thread_id=thread.id,
role="user",
content="I need to solve the equation `3x + 11 = 14`. Can you help me?",
)
...
# Finally run
run = client.beta.threads.runs.retrieve(thread_id=thread.id, run_id=run.id)
```
---
## References:
- [OpenAI Assistants API](https://platform.openai.com/docs/assistants/overview)
- [OpenAI Python Code Examples](https://github.com/openai/openai-python/blob/main/examples)
- [GPT Guide](https://platform.openai.com/docs/guides/text-generation)
- [Visit the OpenAI Cookbook for in-depth example API use-cases, as well as code snippets for common tasks.](https://cookbook.openai.com/)