Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanyuancheung/gpt-go
OpenAI ChatGPT/GPT-4/GPT-3 SDK Go Client to Interact with the GPT-4/GPT-3 APIs.
https://github.com/hanyuancheung/gpt-go
chatgpt chatgpt-api golang gpt-3 gpt-4 openai sdk-go
Last synced: 6 days ago
JSON representation
OpenAI ChatGPT/GPT-4/GPT-3 SDK Go Client to Interact with the GPT-4/GPT-3 APIs.
- Host: GitHub
- URL: https://github.com/hanyuancheung/gpt-go
- Owner: hanyuancheung
- License: apache-2.0
- Created: 2023-03-11T01:43:32.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T11:09:56.000Z (over 1 year ago)
- Last Synced: 2024-12-07T18:11:45.288Z (15 days ago)
- Topics: chatgpt, chatgpt-api, golang, gpt-3, gpt-4, openai, sdk-go
- Language: Go
- Homepage:
- Size: 202 KB
- Stars: 368
- Watchers: 5
- Forks: 26
- Open Issues: 0
-
Metadata Files:
- Readme: README-CN.md
- License: LICENSE
Awesome Lists containing this project
README
GPT-Go: GPT-4/GPT-3 Go-SDK 客户端, 封装 OpenAI 官方 GPT-4/GPT-3 APIs.
========================
English | 中文
[](https://raw.githubusercontent.com/csuzhang/gpt-go/main/LICENSE) 
[](https://pkg.go.dev/github.com/hanyuancheung/gpt-go)
[](https://goreportcard.com/report/hanyuancheung/gpt-go)
[](https://codecov.io/gh/hanyuancheung/gpt-go)
OpenAI 官方文档 API 参考: https://platform.openai.com/docs/api-reference/introduction
> **Note**: 项目已支持 GPT-4 API 调用, 请使用 Chat Completions API 模型.
## 快速开始
```shell
# clone 项目代码至本地
git clone https://github.com/hanyuancheung/gpt-go.git
# 进入项目目录
cd gpt-go
# 设置API_KEY为环境变量
export API_KEY={YOUR_API_KEY} chatgpt
# go build example 二进制
make chatgpt-example
# 运行 example
./chatgpt
```
## 运行效果
## SDK 文档
查看 Go 文档以获取有关所提供类型和方法的更详细文档: https://pkg.go.dev/github.com/hanyuancheung/gpt-go
## 支持 API
- [x] list 引擎 API
- [x] Get 引擎 API
- [x] Completion API (是主要的 gpt-3 API)
- [x] 对 Completion API 的流式支持
- [x] 文档搜索 API
- [x] 图片生成 API
- [x] 替换默认 url、用户代理、超时和其他选项
## 接入案例
ChatGPT streaming completion
```golang
func main() {
client := gpt.NewClient("API_KEY")
err := client.ChatCompletionStream(context.Background(), &gpt.ChatCompletionRequest{
Model: gpt.GPT3Dot5Turbo,
Messages: []gpt.ChatCompletionRequestMessage{
{
Role: "user",
Content: "Hello!",
},
},
}, func(response *gpt.ChatCompletionStreamResponse) {
fmt.Print(response.Choices[0].Delta.Content)
})
if err != nil {
fmt.Printf("ChatCompletionStream error: %v\n", err)
return
}
}
```
GPT-3 completion
```golang
func main() {
client := gpt.NewClient("API_KEY")
rsp, err := client.CompletionWithEngine(context.Background(), &gpt.CompletionRequest{
Model: gpt.TextDavinci003Engine,
Prompt: []string{"Hello!"},
})
if err != nil {
fmt.Printf("ChatCompletionStream error: %v\n", err)
return
}
fmt.Print(rsp.Choices[0].Text)
}
```
DALL-E 2 image generation
```golang
func main() {
client := gpt.NewClient("API_KEY")
rsp, err := client.Image(context.Background(), &gpt.ImageRequest{
Prompt: "Chicken",
})
if err != nil {
fmt.Printf("ChatCompletionStream error: %v\n", err)
return
}
fmt.Print(rsp.Data[0].URL)
}
```
## 贡献者
## 参与贡献
在正式大量开发前, 请在 GitHub 上打开一个 issue 提问.
提交 PR 中的代码必须使用 `gofmt` 进行过滤.
## Star History
[](https://star-history.com/#hanyuancheung/gpt-go&Date)
## 证书
这个包是在 MIT 证书获得许可, 有关详细信息, 请参阅许可证.
## 支持
如果本项目对你有帮助, 欢迎点个 ⭐️ 表示支持!