# chatGPT-service

**Repository Path**: hyades/chatGPT-service

## Basic Information

- **Project Name**: chatGPT-service
- **Description**: chat-GPT3.5服务端的go语言实现，包括用户登陆、会话管理、交互上下文、交互记录持久化等基础功能。
- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2023-04-20
- **Last Updated**: 2023-04-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Chat GPT 服务端

## 工程简介
   本工程采用go语言实现，主体交互部分使用websocket，以流的形式进行实时收发。

## 工程结构

|package |description |
|--------|------------|
|cmd     |项目运行入口包|
|internal|websocket封装、orm封闭、chatgpt基础api封装|
|pkg     |chat GPT交互逻辑主体实现|
|test    |单元测试|


```
├── cmd
│   ├── go.mod
│   └── main.go
├── config
│   └── appsettings.yaml
├── internal
│   ├── dbx
│   ├── middleware
│   ├── openai
│   └── wsbase
├── pkg
│   ├── controller
│   ├── models
│   └── service
|── test
|   └── test.go
├── go.work
├── go.work.sum
├── readme.md
└── LICENSE    
```

### 结构说明：
| package | subpackage | description |
| ------- | -------|---------------------- |
| cmd     | 无         | 项目运行入口包 |
| internal| dbx        | 数据库orm |
|         | middleware | 简单http中间件，跨域控制、安全验证 |
|         | op-enai     | chatgpt基础api封装, （去掉下划线） |
|         | wsbase     | websocket通用框架 |
| pkg     | controller | webapi控制器 |
|         | models     | 全局数据模型 |
|         | service    | chatgpt交互服务实现 |
| test    | 无         | 单元测试 |


#### 注：
1、internal包中的模块为个人其他项目中挪过来的，冗余功能请无视。
2、appsettings.yaml为项目主配置文件，详情见文件中注释。

## 基本webapi说明

|api|description|
| -------- | ------------------ |
| /api/login | 用户登陆，登陆成功后返回安全验证token |
| /api/session/get    | 获取用户会话列表 |
| /api/session/create | 创建会话 |
| /api/session/modify | 更新会话 |
| /api/session/remove | 删除会话 |
| /api/connect        | websocket连接 |