# 人工智能openAi接口

**Repository Path**: WangZhao666/open-ai-interface

## Basic Information

- **Project Name**: 人工智能openAi接口
- **Description**: 后台使用koa,和openai实现
koa-session保存对话上下文
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-02-03
- **Last Updated**: 2023-04-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Koa

## README

# 人工智能openAi接口

#### 介绍
后台使用koa,和openai实现
koa-session保存对话上下文

#### 软件架构
软件架构说明


#### 安装教程

1.  xxxx
2.  xxxx
3.  xxxx

#### 使用说明

1.  git clone克隆项目或下载项目
2.  npm i安装依赖
3.  node app启动服务
4.  服务地址为http://localhost:3000
5.	由于现在国内服务都被墙了，测试时需要自己搭梯子，否则会报timeout的错。正式的话只能部署在国外服务器上才能使用。

#### 接口说明
##### 聊天接口
```
接口URL： http://localhost:3000/api/chat
请求方式： POST
```
###### 请求参数
body参数及说明
| 参数名    | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|--------|-----|------|------|------|
| prompt | 你好  | Text | 是    | 用户输入 |
###### 响应示例
成功响应示例
```
{
	"id": "cmpl-6flGpj0x8NVlg4pgFKZyyKUJihoCH",
	"object": "text_completion",
	"created": 1675411175,
	"model": "text-davinci-003",
	"choices": [
		{
			"text": "你好，有什么可以帮你？",
			"index": 0,
			"logprobs": null,
			"finish_reason": "stop"
		}
	],
	"usage": {
		"prompt_tokens": 188,
		"completion_tokens": 24,
		"total_tokens": 212
	}
}
```
失败响应示例
```
{
	"code": 40022,
	"message": "存在不合法参数!"
}
```
##### 图像接口
```
接口URL： http://localhost:3000/api/image
请求方式： POST
特别注意:  如果以URL的形式输出,生成的图片网址将在1小时后失效
```
###### 请求参数
body参数及说明
| 参数名    | 示例值 | 参数类型 | 是否必填 | 参数描述 |
|--------|-----|------|------|------|
| prompt | 一只可爱的小猫  | Text | 是    | 用户描述 |
| n | 1  | Text | 是    | 生成数量 |
| size | 1024x1024  | Text | 是    | 图像大小 |
| response_format | b64_json  | Text | 否    | 图像格式(只能是url或b64_json)不传时默认为url |
###### 响应示例
成功响应示例
```
{
	"created": 1675998221,
	"data": [
		{
			"url": "https://oaidalleapiprodscus.blob.core.windows.net/private/org-mVheELtVIFdGJ7xlogOrOrqX/user-riIAxndGO3kuS44FvlhOuQCl/img-wCzVIi97ULvmIKA4mkB1WHWJ.png?st=2023-02-10T02%3A03%3A41Z&se=2023-02-10T04%3A03%3A41Z&sp=r&sv=2021-08-06&sr=b&rscd=inline&rsct=image/png&skoid=6aaadede-4fb3-4698-a8f6-684d7786b067&sktid=a48cca56-e6da-484e-a814-9c849652bcb3&skt=2023-02-09T21%3A36%3A44Z&ske=2023-02-10T21%3A36%3A44Z&sks=b&skv=2021-08-06&sig=e6HN5MFXW5v9OqnvdwrbQTPchgWCrUezejau/zxqTuk%3D"
		}
	]
}
```
失败响应示例
```
{
	"code": 40022,
	"message": "存在不合法参数!"
}
```

#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request


#### 特技

1.  使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md
2.  Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com)
3.  你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目
4.  [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5.  Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help)
6.  Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/)