Metadata-Version: 2.1
Name: py-chatgpt-plus
Version: 0.2.0
Summary: Python chatgpt api
Home-page: https://github.com/rosemary666/chatgpt
Author: rosemary666
Author-email: 
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# chatgpt

![](https://img.shields.io/badge/language-python-blue.svg)
[![Forks](https://img.shields.io/github/forks/rosemary666/chatgpt)](https://img.shields.io/github/forks/rosemary666/chatgpt)
[![Stars](https://img.shields.io/github/stars/rosemary666/chatgpt)](https://img.shields.io/github/stars/rosemary666/chatgpt)
[![Contributors](https://img.shields.io/github/contributors/rosemary666/chatgpt)](https://github.com/rosemary666/chatgpt/graphs/contributors)
[![Docs](https://github.com/rosemary666/chatgpt/actions/workflows/deploy_doc.yaml/badge.svg)](https://github.com/rosemary666/chatgpt/actions/workflows/deploy_doc.yaml)
[![Pypi](https://github.com/rosemary666/chatgpt/actions/workflows/publish_pypi.yaml/badge.svg)](https://github.comrosemary666/chatgpt/actions/workflows/publish_pypi.yaml)
[![License: Apache2.0](https://img.shields.io/github/license/rosemary666/chatgpt)](https://github.com/rosemary666/chatgpt/blob/main/LICENSE)

[DOCS](https://rosemary666.github.io/chatgpt/)

chatgpt库的封装调用, 支持流式和非流式。

## 特性
- 支持流式和非流式
- 支持底层调用chatgpt的封装(很easy启动)
- 支持上层Http服务的封装调用(支持sse方式)

## 调用

### 安装
```shell
pip install py-chatgpt-plus
```

### 底层调用 
- 非流式

```python
from py_chatgpt_plus.core.chat_gpt_3 import ChatGptV3

cg = ChatGptV3(
    api_key="*****",
    system_prompt="请帮我把以下的工作内容填充为工作周报，用markdown格式以分点叙述的方式输出:",
)
answer = cg.chat_once("主要开展了三件事情, 第一是完成功能1的开发，第二是完成了xx的需求评审，第三是接待了xx客户")
print(answer)
cg.save_conversations("./conversations.json")
```

- 流式

```python
from py_chatgpt_plus.core.chat_gpt_3 import ChatGptV3

cg = ChatGptV3(
    api_key="****"  # 请填写自己生成的api_key
)

streams = cg.chat_stream(prompt="**")  # 返回的流式结果
for stream in streams:
    print(stream)
```

### 上层调用
上层支持以sse的接口形式将结果返回给调用方，采用该方式可模拟chatgpt官方网页显示效果。

服务启动方式: 
```shell
1. cd python/py_chatgpt_plus      
2. 修改conf/service.yaml配置文件(重点配置api_key和proxy)      
3. 执行run.sh即可启动   
```
     

### 接口文档
浏览器打开:
```shell
http://${ip}:${port}/api/v1/doc
```
即可在线访问(注意替换ip和port为真实启动的)

