OpenAI provides us the ability to invoke its features via RESTful APIs. This blog shows how to invoke the API using Spring Boot. There is nothing special here and no OpenAI Java libraries that I use. One can do the same in standard Java (non-spring) or even in more concise code with Nodejs. But here goes a sample with Spring Boot.
For starters you have to create an account with OpenAI. If this is your first time you can get free credits to use (it does expire). Otherwise you have to provide a credit card. If providing payment details then please set hard & soft billing checks (in dollar amounts). A hard check when reached will ensure that no more API calls are allowed. A soft check just sends an email notification when a limit is reached. Set it, and you will thank yourself later.
Next, you need to create an API Key to access OpenAI programmatically.
You will need the API key in a bit. The Java code is at the GitHub repo here. There are a bunch of DTOs that model the OpenAI request & response. I will skip those of course (as they are just POJO’s).
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
@RestController public class OpenAIChatController { @Qualifier("restTemplate") @Autowired private RestTemplate restTemplate; @Value("${openai.model}") private String model; @Value("${openai.apiUrl}") private String apiUrl; @PostMapping("/chat") @ResponseBody public ResponseEntity<OpenAIResponse> chatwithme ( @RequestBody UserAIPrompt userAIPrompt) { OpenAIRequest request = new OpenAIRequest(model, userAIPrompt.getPrompt()); OpenAIResponse response = restTemplate.postForObject(apiUrl, request, OpenAIResponse.class); if (response == null || response.getChoices() == null || response.getChoices().isEmpty()) { return new ResponseEntity<OpenAIResponse>(HttpStatus.NOT_FOUND); } return new ResponseEntity<OpenAIResponse>(response, HttpStatus.OK); } } |
A standard Spring RestTemplate is used to invoke the REST API. Edit the application.properties to add in your API KEY
|
1 2 3 4 |
openai.model=gpt-3.5-turbo openai.apiUrl=https://api.openai.com/v1/chat/completions openai.apiKey=<place your openai api key here --- any code in my git repo is expired> server.port=9090 |
Finally run the code using
|
1 2 3 |
mvn clean spring-boot:run curl http://localhost:9090/chat -i -H "Accept: application/json" -H "Content-Type:application/json" -X POST --data '{"prompt": "which year was the colossium built?"} |
