Skip to content

Commit bb7d67d

Browse files
bluecheatbluecheat
committed
📝 문서 및 일부 struct명 변경
1 parent 55c8c19 commit bb7d67d

4 files changed

Lines changed: 346 additions & 46 deletions

File tree

‎LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md‎

Lines changed: 133 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,142 @@
1-
# k-openai
1+
# K-Openai
2+
3+
K-openai는 OpenAI의 API 사용을 위한 프롬프트 작성 시 파파고 번역기능을 통해 Token 사용량 최소화와 서비스 형태에 맞는 응답을 하기 위해 제작하게 되었습니다.
4+
5+
## 목차
6+
- [1. 사전 준비](#사전-준비)
7+
- [2. 설치 방법](#설치-방법)
8+
- [3. Config 설정 방법](#Config-설정-방법)
9+
- [4. 사용 방법](#사용-방법)
10+
- Chat API (GPT 채팅 API)
11+
- ImageGenerate API ( 이미지 생성 API )
12+
13+
## 사전 준비
14+
- `go version >= 1.18` 이상 설치 되어 있어야합니다.
15+
- [OpenAI](https://platform.openai.com/) 에서 API Key를 발급 받아야합니다.
16+
- [Naver Developers](https://developers.naver.com/main/)에서 client를 발급 받아야합니다.
217

3-
k-openai는 Go 언어로 작성된 오픈소스 프로젝트로, OpenAI와 Naver Open API를 사용하여 다양한 기능을 제공합니다.
418

519
## 설치 방법
20+
터미널 또는 명령 프롬프트를 열고 다음 명령어를 실행하여 의존성을 설치합니다.
21+
```
22+
go get -u github.com/bluecheat/k-openai@v0.1.0
23+
```
24+
25+
## Config 설정 방법
626

7-
1. Go가 설치되어 있지 않다면, [Go 공식 웹사이트](https://golang.org/dl/)에서 Go를 설치하세요.
8-
2. 터미널 또는 명령 프롬프트를 열고 다음 명령어를 실행하여 이 프로젝트를 클론하세요:
27+
#### 1. yaml 파일을 읽어서 설정하는 방법
28+
```go
29+
config, err := kopenai.LoadConfiguration("./kopenai_env.yml")
30+
if err != nil {
31+
log.Fatal(err)
32+
}
933
```
10-
go get github.com/bluecheat/k-openai
11-
go mod tidy
34+
35+
#### 2. 변수 직접 선언 방법
36+
```go
37+
config := kopenai.Config{
38+
Openai: kopenai.OpenAiConfig{
39+
ApiKey: "apikey",
40+
},
41+
Naver: kopenai.NaverOpenApiConfig{
42+
ClientId: "clinetId",
43+
ClientSecret: "clientSecret",
44+
},
45+
}
1246
```
13-
3. 다음 명령어를 실행하여 필요한 Go 모듈을 설치하세요:
1447

1548
## 사용 방법
16-
1. main.go 파일을 생성하고 다음과 같은 기본 코드를 작성하세요:
49+
50+
### 1. Chat API `kopenai.Chat` ( GPT 채팅 API )
51+
[Chat API](https://platform.openai.com/docs/api-reference/chat)에서 사용하는 요청값, 응답값은 동일하고 추가적으로 번역 옵션을 넣어서 처리합니다.
52+
53+
#### 파라미터 정보
54+
- `openai.ChatCompletionRequest`: 기존의 openai의 Chat 호출 시 사용되는 요청값
55+
- `kopenai.ChatTransOption`: 프롬프트 번역 시 사용하는 Option
56+
- InputPrompt: 프롬프트에 대한 번역 ( source: 기존 언어, target: 번역할 언어 )
57+
- OutputPrompt: 프롬프트 결과에 대한 번역 ( source: 기존 언어, target: 번역할 언어 )
58+
59+
#### 예제 코드
1760
```go
18-
package main
19-
20-
import (
21-
"fmt"
22-
"log"
23-
"github.com/bluecheat/k-openai"
24-
)
25-
26-
func main() {
27-
// 환경 설정 로드
28-
config, err := kopenai.LoadConfiguration()
29-
if err != nil {
30-
log.Fatal(err)
31-
}
32-
33-
// OpenAI 클라이언트 초기화
34-
openaiClient := kopenai.NewOpenAIClient(config.OpenAI.ApiKey)
35-
36-
// 예제: OpenAI를 사용하여 텍스트 생성
37-
response, err := openaiClient.CreateCompletion("Hello, world! How are you today?")
38-
if err != nil {
39-
log.Fatal(err)
40-
}
41-
fmt.Println("OpenAI Response:", response)
42-
43-
// Naver 클라이언트 초기화
44-
naverClient := kopenai.NewNaverClient(config.Naver.ClientID, config.Naver
45-
```
61+
...
62+
63+
client := kopenai.NewKopenAiGpt(config)
64+
65+
ctx := context.Background()
66+
resp, err := client.Chat(ctx, openai.ChatCompletionRequest{
67+
Model: openai.GPT3Dot5Turbo,
68+
Messages: []openai.ChatCompletionMessage{
69+
{
70+
Role: openai.ChatMessageRoleUser,
71+
Content: "안녕 너의 이름은 뭐니?",
72+
},
73+
},
74+
}, kopenai.ChatTransOption{
75+
InputPrompt: &kopenai.TransOption{
76+
Source: kopenai.KO,
77+
Target: kopenai.EN,
78+
},
79+
OutputPrompt: &kopenai.TransOption{
80+
Source: kopenai.EN,
81+
Target: kopenai.KO,
82+
},
83+
})
84+
if err != nil {
85+
t.Error(err)
86+
return
87+
}
88+
fmt.Println(resp.Choices[0].Message)
89+
```
90+
91+
### 2. ImageGenerate API `kopenai.ImageGenerate` ( 이미지 생성 API )
92+
[ImageGenerate API](https://platform.openai.com/docs/api-reference/images/create)에서 사용하는 요청값, 응답값은 동일하고 추가적으로 번역 옵션을 넣어서 처리합니다.
93+
#### 파라미터 정보
94+
- `openai.ImageRequest`: 기존의 openai의 ImageGenerate 호출 시 사용되는 요청값
95+
- `kopenai.ImageTransOption`: 프롬프트 번역 시 사용하는 Option
96+
- InputPrompt: 프롬프트에 대한 번역 ( source: 기존 언어, target: 번역할 언어 )
97+
98+
#### 예제 코드
99+
100+
```go
101+
...
102+
client := kopenai.NewKopenAiGpt(config)
103+
104+
ctx := context.Background()
105+
resp, err := client.ImageGenerate(ctx, openai.ImageRequest{
106+
Prompt: "업무, 개발, AI개발",
107+
N: 1,
108+
Size: openai.CreateImageSize256x256,
109+
ResponseFormat: openai.CreateImageResponseFormatB64JSON,
110+
}, kopenai.ImageTransOption{
111+
InputPrompt: &kopenai.TransOption{
112+
Source: kopenai.KO,
113+
Target: kopenai.EN,
114+
},
115+
})
116+
if err != nil {
117+
t.Error(err)
118+
return
119+
}
120+
121+
// Open output file
122+
dec, err := base64.StdEncoding.DecodeString(resp.Data[0].B64JSON)
123+
if err != nil {
124+
panic(err)
125+
}
126+
output, err := os.Create("created-image-" + time.Now().UTC().String() + ".png")
127+
if err != nil {
128+
panic(err)
129+
}
130+
// Close output file
131+
defer output.Close()
132+
133+
if _, err := output.Write(dec); err != nil {
134+
panic(err)
135+
}
136+
if err := output.Sync(); err != nil {
137+
panic(err)
138+
}
139+
```
140+
141+
#### 이미지 생성 결과
142+
![image](https://github.com/bluecheat/k-openai/assets/55500108/36b1593b-37d3-4694-830a-5304e0a742c0)

0 commit comments

Comments
 (0)