(Spring Boot) Open AI ChatGPT API 연동

1️⃣ API Key 생성

➡️ API 를 사용하기 위해서는 API Key 를 발급받아야한다.

OpenAI API

➡️ 생성된 키는 Client 코드 쪽에서 노출되면 안된다.

2️⃣ API Parameter 와 Authentication

① API Parameter

✔️ model

OpenAI API

최근에 gpt-4 가 나왔지만 나는 gpt-3.5-turbo 를 사용하기로 했다.

✔️ Message

• role : message 송수신자
  • user : message 송신자
  • assistant : message 수신자
•  content : ChatGPT 에 보내는 실제 내용

② Authentication

➡️ 앞서 발급한 API Key 를 헤더에 넣어서 요청을 보낸다.

③ ChatGPT 에 보내는 요청 예시

$ curl https://api.openai.com/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -d '{
    "model": "gpt-3.5-turbo",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

④ API 에 추가적으로 보낼 수 있는 파라미터 (Optional Parameters)

• n : 생성할 응답의 개수 (default : 1)
• temperature : 응답의 무작위성 (default : 1)
• max_tokens : 응답 토큰 수의 제한 (default : infinity)

3️⃣ API 응답 형태

➡️ json 형태로 넘어온다. Object 의 배열 형태로 오는데, n 파라미터를 따로 정해놓지 않으면 1개의 Object 만 온다.

{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [{
    "index": 0,
    "message": {
      "role": "assistant",
      "content": "\n\nHello there, how may I assist you today?"
    },
    "finish_reason": "stop"
  }],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

4️⃣ 프로젝트 적용 _ (1) Request & Response DTO 생성

① Message

import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class Message {

    private String role;
    private String content;
}

② ChatReq

import java.util.ArrayList;
import java.util.List;
import lombok.Getter;

@Getter
public class ChatReq {
    private String model;
    private List<Message> messages;

    public ChatReq (String model, String prompt) {
        this.model = model;

        this.messages = new ArrayList<>();
        this.messages.add(new Message("user", prompt));
    }
}

③ ChatRes

import com.inha.server.chatGPT.dto.Message;
import java.util.List;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
public class ChatRes {
    private List<Choice> choices;

    @Getter
    @Setter
		@NoArgsConstructor
    @AllArgsConstructor
    public static class Choice {
        private int index;
        private Message message;
    }
}

5️⃣ 프로젝트 적용 _ (2) : application.yml 파일 작성

① application.yml

openai :
  model : gpt-3.5-turbo
  api :
    url : {선택한 model 의 endpoint}
    key : {앞서 발급받은 API Key}

6️⃣ 프로젝트 적용 _ (3) : RestTemplate 작성

① OpenAIRestTemplateConfig

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.client.RestTemplate;

@Configuration
public class OpenAIRestTemplateConfig {

    @Value("${openai.api.key}")
    private String openaiApiKey;

    @Bean
    @Qualifier("openaiRestTemplate")
    public RestTemplate openaiRestTemplate() {
        RestTemplate restTemplate = new RestTemplate();
        restTemplate.getInterceptors().add(
            (request, body, execution)
                -> {
                request.getHeaders().add("Authorization", "Bearer " + openaiApiKey);
                return execution.execute(request, body);
            });
        return restTemplate;
    }
}

7️⃣ 프로젝트 적용 _ (4) : Controller 작성

① ChatController

import com.inha.server.chatGPT.dto.request.ChatReq;
import com.inha.server.chatGPT.dto.response.ChatRes;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
public class ChatController {
    @Qualifier("openaiRestTemplate")
    @Autowired
    private RestTemplate restTemplate;

    @Value("${openai.model}")
    private String model;

    @Value("${openai.api.url}")
    private String apiUrl;

    @GetMapping("/chat")
    public String chat(@RequestParam String prompt) {
        ChatReq request = new ChatReq(model, prompt);

        // api 호출
        ChatRes response = restTemplate.postForObject(apiUrl, request, ChatRes.class);

        if (response == null || response.getChoices() == null || response.getChoices().isEmpty()) {
            return "No response";
        }

        return response.getChoices().get(0).getMessage().getContent();
    }
}

8️⃣ 응답 확인

➡️ Postman 을 통해 응답을 확인했다.

🔗 참고

https://www.baeldung.com/spring-boot-chatgpt-api-openai