GPT의 Custom Actions 기능을 사용하여 외부 API 호출을 통해 데이터를 검색하는 방법에 대해 구체적인 예로, 사용자가 입력한 우편번호에 대한 주소를 찾아 응답하는 GPTs 만드는 과정을 Google Apps Script를 활용하여 설명하겠습니다. 이 프로세스는 Google 스프레드시트에 우편번호와 주소 데이터를 저장하고, Google Apps Script를 사용하여 이 데이터를 검색한 다음, GPTs를 통해 사용자에게 해당 주소 정보를 제공하는 방식으로 진행됩니다.
1. Google 스프레드시트 준비
- 스프레드시트 생성: Google 드라이브에서 우편번호와 주소 정보를 포함하는 스프레드시트를 생성합니다.
- 데이터 입력: 우편번호와 해당하는 주소를 스프레드시트에 입력합니다.
- 스프레드시트 ID 확인: 스프레드시트 URL에서 스프레드시트의 고유 ID(
/d/와/edit사이의 문자열)를 확인합니다. 예:https://docs.google.com/spreadsheets/d/[스프레드시트-ID]/edit.
2. Google Apps Script 작성
- Apps Script 프로젝트 생성: 생성한 스프레드시트에서
확장 프로그램 > Apps Script를 선택하여 새로운 Apps Script 프로젝트를 생성합니다. - 스크립트 코드 작성: 사용자의 질의에서 우편번호를 검색하고, 해당하는 주소를 반환하는 기능을 구현하는 Apps Script를 작성합니다. 스크립트는 HTTP GET 요청의 파라미터로 받은 우편번호를 스프레드시트에서 검색하고, 일치하는 주소 정보를 JSON 형식으로 반환합니다.
- 저장 및 이름 지정: 스크립트 저장 후, 프로젝트에 이름을 지정합니다.
아래는 사용자의 질의에서 우편번호를 검색하고 해당하는 주소를 반환하는 Google Apps Script 예시 코드입니다. 이 코드는 HTTP GET 요청으로 받은 우편번호를 스프레드시트에서 검색하여 일치하는 주소 정보를 JSON 형식으로 반환합니다.
Apps Script 예시 코드
function doGet(e) {
console.log("Received request with parameters: ", e.parameters); // 요청 받음
var zipcode = e.parameter.zipcode; // 'zipcode' 파라미터 값을 가져옵니다.
// 우편번호 파라미터 확인
if (!zipcode) {
console.log("Zipcode parameter is missing"); // 우편번호 파라미터 누락 로그
return ContentService.createTextOutput(JSON.stringify({"error": "Zipcode parameter is missing"}))
.setMimeType(ContentService.MimeType.JSON);
}
console.log("Searching for zipcode: ", zipcode); // 우편번호 검색 로그
var sheet = SpreadsheetApp.openById('YOUR_SPREADSHEET_ID').getSheetByName('Sheet1'); // 스프레드시트 접근 로그
console.log("Opened sheet: Sheet1"); // 시트 열림 로그
var data = sheet.getDataRange().getValues(); // 시트 데이터 가져오기
console.log("Retrieved data from sheet"); // 시트 데이터 검색 로그
for (var i = 1; i < data.length; i++) {
console.log("Checking row ", i, " with zipcode: ", data[i][0]); // 현재 행의 우편번호 확인 로그
if (data[i][0] == zipcode) { // 일치하는 우편번호 검색
var address = data[i][1]; // 주소 가져오기
console.log("Found address: ", address, " for zipcode: ", zipcode); // 일치하는 주소 발견 로그
return ContentService.createTextOutput(JSON.stringify({"address": address}))
.setMimeType(ContentService.MimeType.JSON); // 주소 반환
}
}
console.log("No address found for the provided zipcode: ", zipcode); // 일치하는 주소 없음 로그
return ContentService.createTextOutput(JSON.stringify({"error": "No address found for the provided zipcode"}))
.setMimeType(ContentService.MimeType.JSON);
}코드 설명
- 파라미터 수신:
e.parameter.zipcode를 통해 GET 요청에서 전달된zipcode파라미터 값을 가져옵니다. 이 값은 사용자가 질의한 우편번호입니다. - 스프레드시트 접근:
SpreadsheetApp.openById('YOUR_SPREADSHEET_ID').getSheetByName('Sheet1')를 사용하여 특정 스프레드시트의 지정된 시트에 접근합니다. 여기서'YOUR_SPREADSHEET_ID'는 실제 스프레드시트의 ID로 대체해야 하며,'Sheet1'은 우편번호와 주소가 저장된 시트의 이름입니다. - 데이터 검색:
getValues()메서드로 시트의 모든 데이터를 2차원 배열로 가져온 후, 반복문을 사용하여 각 행의 첫 번째 열(우편번호가 위치한 열)을 검색합니다. 입력받은 우편번호와 일치하는 행이 있는지 확인합니다. - 응답 반환: 일치하는 우편번호가 있으면 해당 행의 주소 정보를 JSON 형식으로 반환합니다.
ContentService.createTextOutput().setMimeType(ContentService.MimeType.JSON)을 사용하여 응답 형식을 JSON으로 설정합니다. - 오류 처리: 입력받은 우편번호가 파라미터로 제공되지 않았거나, 스프레드시트에서 해당 우편번호를 찾을 수 없는 경우 오류 메시지를 JSON 형식으로 반환합니다.
이 스크립트를 Apps Script에서 배포한 후, 생성된 웹 앱 URL을 GPT의 Custom Actions 설정에 사용하면, 사용자가 입력한 우편번호에 대한 주소 정보를 검색하여 반환하는 기능을 구현할 수 있습니다.
3. Google Apps Script 배포
- 배포 준비 및 설명: Apps Script 편집기에서
배포 > 새로운 배포선택하고, 배포에 대한 설명을 입력합니다. 예:우편번호 검색 API. - 접근 권한 설정: 웹 앱의 설정에서
누구나(익명 포함)액세스할 수 있도록 설정하여, GPT에서 API 호출이 가능하도록 합니다. - 웹 앱으로 배포:
배포버튼을 클릭하여 스크립트를 웹 앱으로 배포합니다. - 웹 앱 URL 복사: 배포 후 표시되는 웹 앱의 URL을 복사합니다. 이 URL은 GPT의 Custom Actions에서 호출될 API 엔드포인트로 사용됩니다.
4. GPT Custom Actions 설정
- Custom Actions Schema 정의: OpenAI 플랫폼에서 Custom Actions를 설정할 때, 생성한 웹 앱의 URL을 API 엔드포인트로 사용하여 OpenAPI 3.1.0 스키마 형식으로 API의 구조를 정의합니다. 구체적으로, API 요청을 보낼 URL, 요청 시 필요한 매개변수, 응답으로 받을 데이터 형식 등을 명시합니다.
- Custom Actions 사용: 설정한 Custom Actions를 통해 GPT 모델이 사용자 질문에 기반해 Google Apps Script API를 호출하고, 스크립트에서 반환된 데이터를 바탕으로 사용자에게 응답을 생성하여 제공합니다.
GPT의 Custom Actions 기능을 사용하여 위에서 작성한 Google Apps Script 웹 앱과 통합하기 위한 OpenAPI 3.0 스키마 정의 예시입니다. 이 스키마는 GPT 모델이 사용자의 우편번호 입력에 기반하여 Apps Script 웹 앱을 호출하고, 호출 결과로 받은 주소 정보를 사용자에게 제공하는 방법을 정의합니다.
GPT Custom Actions 스키마 정의 예시
{
"openapi": "3.0.0",
"info": {
"title": "Address Lookup API",
"version": "1.0.0",
"description": "This API looks up the address for a given zipcode."
},
"servers": [
{
"url": "https://script.google.com/macros/s/YOUR_DEPLOYMENT_ID/exec",
"description": "The base URL for the Address Lookup API"
}
],
"paths": {
"/": {
"get": {
"summary": "Address Lookup by Zipcode",
"operationId": "getAddressByZipcode",
"parameters": [
{
"name": "zipcode",
"in": "query",
"required": true,
"description": "The zipcode to lookup the address for",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "A successful response with the address",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "The address corresponding to the input zipcode"
}
},
"required": [
"address"
]
}
}
}
},
"default": {
"description": "An error response",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "The error message"
}
}
}
}
}
}
}
}
}
}
}스키마 설명
- info: API에 대한 기본 정보를 제공합니다. 여기에는 API의 이름, 버전, 설명이 포함됩니다.
- servers: API의 서버 URL을 정의합니다.
YOUR_DEPLOYMENT_ID부분은 실제 Google Apps Script 웹 앱의 배포 ID로 교체해야 합니다. - paths: API의 엔드포인트 및 해당 엔드포인트에서 지원하는 작업을 정의합니다. 여기서는 루트 경로(
/)에 대한 GET 요청을 정의하고 있으며, 이는 우편번호를 입력으로 받아 주소를 조회하는 작업을 나타냅니다. - parameters: 요청 시 필요한 파라미터를 정의합니다. 여기서는
zipcode라는 쿼리 파라미터를 필수로 받도록 설정했습니다. - responses: API 호출의 응답을 정의합니다.
200응답은 성공적으로 주소를 찾았을 때의 응답 스키마를,default응답은 오류 발생 시의 응답 스키마를 나타냅니다.
이 스키마를 GPT의 Custom Actions 설정에 적용하면, GPT 모델은 사용자의 우편번호 질의에 기반하여 정의된 API를 호출하고, 결과로 받은 주소 정보를 사용자에게 제공할 수 있습니다.
5. GPTs와의 통합 및 사용
- 질의 처리: 사용자가 GPTs에 우편번호를 기반으로 질의하면, GPT 모델은 설정된 Custom Actions를 통해 Apps Script에 우편번호를 전달합니다.
- Apps Script에서 주소 검색: Apps Script는 받은 우편번호를 사용하여 스프레드시트에서 해당 주소를 검색합니다.
- 응답 및 결과 처리: 검색된 주소 정보는 JSON 형식으로 GPTs에 응답되며, GPTs는 이 정보를 기반으로 사용자에게 해당 주소를 제공합니다.
이 과정을 통해 사용자가 우편번호를 기반으로 질의할 때, GPT의 Custom Actions 기능을 활용하여 Google Apps Script와 Google 스프레드시트를 사용하는 외부 API를 호출해서 해당 우편번호의 주소 정보를 조회하고, 조회된 정보를 바탕으로 사용자가 입력한 우편번호에 대한 주소를 응답하는 시스템을 구축할 수 있습니다. 이 방법은 GPT와 다양한 외부 데이터 소스를 통합하여 유용한 사용자 경험을 제공하는 데 활용될 수 있습니다.
728x90
댓글