AI데이터 구축 일자리 참여 바로가기

객체검출 API

객체검출 API 란?

이미지에서 사람, 자동차 등 일반적으로 나타나는 다양한 종류의 객체 카테고리를 분류하고 객체의 위치정보(박스 좌표)를 감지할 수 있는 기술로 활용됩니다. 영상 데이터에서 다양한 형태의 객체를 인식하는 객체 인식기를 통해 객체 인식 결과를 제공합니다. 객체 검출 (Object Detection) API는 HTTP 기반의 REST API 인터페이스로 JSON 포맷 기반의 입력 및 출력을 지원하며 ETRI에서 제공하는 API Key 인증을 통해 사용할 수 있는 Open API 입니다.

지원하는 객체 카테고리 (총 80개)

person, bicycle, car, motorcycle, airplane, bus, train, truck, boat, traffic light, fire hydrant, stop sign, parking meter, bench, bird, cat, dog, horse, sheep, cow, elephant, bear, zebra, giraffe, backpack, umbrella, handbag, tie, suitcase, frisbee, skis, snowboard, sports ball, kite, baseball bat, baseball glove, skateboard, surfboard, tennis racket, bottle, wine glass, cup, fork, knife, spoon, bowl, banana, apple, sandwich, orange, broccoli, carrot, hot dog, pizza, donut, cake, chair, couch, potted plant, bed, dining table, toilet, tv, laptop, mouse, remote, keyboard, cell phone, microwave, oven, toaster, sink, refrigerator, book, clock, vase, scissors, teddy, bear, hair drier, toothbrush

API 호출 1일 허용량
기술명 API명 1일 허용량
객체검출 API 사용하기

객체검출 API는 REST API이며, 질문과 단락 데이터를 HTTP 통신으로 ETRI Open API 서버에 전달하면 됩니다. 서버가 제공하는 REST API의 URI는 다음과 같으며 POST 방식으로 호출해야 합니다.

http://aiopen.etri.re.kr:8000/ObjectDetect

HTTP 요청으로 객체검출 분석을 요청할 때 사전 준비 사항에서 발급받은 API Key정보를 요청 본문에 포함시켜야 합니다. 다음은 HTTP 요청 메시지 예입니다.

[HTTP Request Body]
{
		"request_id": "reserved field",
		"access_key": “YOUR_ACCESS_KEY”,
		"argument": {
			"file": “BASE64_STRING_IMAGE”,
			"type": “IMAGE_FILE_TYPE”
		}
}
							

위와 같은 HTTP 요청을 ETRI Open API 서버로 전달하면 ETRI Open API 서버는 JSON 형태의 Text 데이터를 HTTP 응답 메시지로 반환합니다. 다음은 HTTP 응답 예제 입니다.

[HTTP Respone Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8

[HTTP Respone Body]
{
		"request_id": "reserved field",
		"result": 0,
		"return_type": "com.google.gson.internal.LinkedTreeMap",
		"return_object": {객체검출 결과 JSON}
}
							
구현 예제
Java

JSON parsing을 위해 Gson 라이브러리를 사용하여 제공하고 있습니다. Gson 라이브러리에 대한 자세한 설명은 https://github.com/google/gson 에서 확인 하실 수 있습니다.

import java.io.DataOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Base64;

import com.google.gson.Gson;

public class Example {

	static public void main ( String[] args ) {
		String openApiURL = "http://aiopen.etri.re.kr:8000/ObjectDetect";
		String accessKey = "YOUR_ACCESS_KEY";    // 발급받은 API Key
		String type = "IMAGE_FILE_TYPE";     // 이미지 파일 확장자
		String file = "IMAGE_FILE_PATH";  	// 이미지 파일 경로
		String imageContents = "";
		Gson gson = new Gson();

		Map<String, Object> request = new HashMap<>();
		Map<String, String> argument = new HashMap<>();

		try {
			Path path = Paths.get(file);
			byte[] imageBytes = Files.readAllBytes(path);
			imageContents = Base64.getEncoder().encodeToString(imageBytes);
		} catch (IOException e) {
			e.printStackTrace();
		}

		argument.put("type", type);
		argument.put("file", imageContents);

		request.put("access_key", accessKey);
		request.put("argument", argument);

		URL url;
		Integer responseCode = null;
		String responBody = null;
		try {
			url = new URL(openApiURL);
			HttpURLConnection con = (HttpURLConnection)url.openConnection();
			con.setRequestMethod("POST");
			con.setDoOutput(true);

			DataOutputStream wr = new DataOutputStream(con.getOutputStream());
			wr.write(gson.toJson(request).getBytes("UTF-8"));
			wr.flush();
			wr.close();

			responseCode = con.getResponseCode();
			InputStream is = con.getInputStream();
			byte[] buffer = new byte[is.available()];
			int byteRead = is.read(buffer);
			responBody = new String(buffer);

			System.out.println("[responseCode] " + responseCode);
			System.out.println("[responBody]");
			System.out.println(responBody);

		} catch (MalformedURLException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}
										
PHP
<?php
	$openApiURL = "http://aiopen.etri.re.kr:8000/ObjectDetect";
	$accessKey = "YOUR_ACCESS_KEY";
	$type = "IMAGE_FILE_TYPE";
	$filePath = "IMAGE_FILE_PATH";
	$imageContents = base64_encode( file_get_contents($filePath ) );

	$request = array(
	"access_key" => $accessKey,
		"argument" => array (
			"type" => $type,
			"file" => $imageContents
		)
	);

	try {
		$server_output = "";
		$ch = curl_init();
		$header = array(
			"Content-Type:application/json; charset=UTF-8",
		);
		curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
		curl_setopt($ch, CURLOPT_URL, $openApiURL);
		curl_setopt($ch, CURLOPT_VERBOSE, true);
		curl_setopt($ch, CURLOPT_POST, 1);
		curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode ( $request) );

		$server_output = curl_exec ($ch);
		if($server_output === false) {
			echo "Error Number:".curl_errno($ch)."\n";
			echo "Error String:".curl_error($ch)."\n";
		}

		curl_close ($ch);
	} catch ( Exception $e ) {
		echo $e->getMessage ();
	}

	echo "result = " . var_dump($server_output);
?>
										
C++

JSON parsing을 위해 jsoncpp 라이브러리를 사용하여 제공하고 있습니다. jsoncpp 라이브러리에 대한 자세한 설명은 https://github.com/open-source-parsers/jsoncpp 에서 확인 하실 수 있습니다.

HTTP 통신을 위해 curl 라이브러리를 사용하여 제공하고 있습니다. curl 라이브러리에 대한 자세한 설명은 https://curl.haxx.se/libcurl 에서 확인 하실 수 있습니다.

컴파일을 위해서는 아래와 같이 추가된 LIB에 대한 옵션을 추가해야 합니다.
g++ (c++파일명) (JSONCPP)/json/json.h (JSONCPP)/json/json-forwards.h (JSONCPP)/jsoncpp.cpp ?I(CURL)/include -lcurl

#include <curl/curl.h>
#include <json/json.h>
#include <iostream>
#include <string>
#include <memory.h>
#include <fstream>
#include <math.h>


#define LENFRAME  800

using namespace std;

size_t writeDataFunc(void *ptr, size_t size, size_t nmemb, string stream);
string base64_encode(unsigned char const* , unsigned int len);

static const string base64_chars =
			 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
			 "abcdefghijklmnopqrstuvwxyz"
			 "0123456789+/";
int main() {
	char* openApiURL = (char*)"http://aiopen.etri.re.kr:8000/ObjectDetect";
	char* imageFilePath = (char*)"IMAGE_FILE_PATH";
	string accessKey = "YOUR_ACCESS_KEY";
	string type = "IMAGE_FILE_TYPE";

	Json::Value request;
	Json::Value argument;
	FILE* fp = fopen(imageFilePath, "rt" );
	unsigned char sbuf[LENFRAME];
	unsigned int nRead = 0;
	unsigned int nWrite = 0;

	unsigned char* imageBytes;
	unsigned char* newimageBytes;
	while ( 0 < ( nRead = fread( sbuf, sizeof( char ), LENFRAME, fp ) ) ) {
		newimageBytes = new unsigned char[nWrite + nRead];
		if ( 0 < nWrite ) {
			memcpy(newimageBytes, imageBytes, nWrite * sizeof(char));
		}
		memcpy(newimageBytes + nWrite, sbuf, nRead * sizeof(char));
		nWrite = nWrite + nRead;
		imageBytes = new unsigned char[nWrite];
		memcpy(imageBytes, newimageBytes, nWrite * sizeof(char));
	}
	fclose(fp);

	argument["type"] = type;
	argument["file"] = base64_encode( imageBytes , nWrite);

	request["access_key"] = accessKey;
	request["argument"] = argument;

	CURL *curl;
	curl_slist* responseHeaders = NULL;
	curl = curl_easy_init();

	if( curl == NULL ) {
	} else {
		responseHeaders = curl_slist_append( responseHeaders , "Content-Type: application/json; charset=UTF-8" ) ;
		string requestJson = request.toStyledString();
		long statusCode;
		string response;

		curl_easy_setopt(curl, CURLOPT_URL, openApiURL);
		curl_easy_setopt(curl, CURLOPT_HTTPHEADER, responseHeaders ) ;
		curl_easy_setopt(curl, CURLOPT_TIMEOUT, 5);
		curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
		curl_easy_setopt(curl, CURLOPT_POSTFIELDS, requestJson.c_str());
		curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, writeDataFunc);
		curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

		curl_easy_perform(curl);

		curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &statusCode);
		curl_easy_cleanup(curl);

		cout << "[responseCode] " << statusCode << endl;
		cout << "[responBody]" << endl;
		cout << response << endl;
	}

	return 0;
}

size_t writeDataFunc(void *ptr, size_t size, size_t nmemb, string stream) {
	size_t realsize = size * nmemb;
	string temp(static_cast<const char*>(ptr), realsize);
	stream.append(temp);
	return realsize;
}

string base64_encode(unsigned char const* bytes_to_encode, unsigned int in_len) {
	string ret;
	int i = 0;
	int j = 0;
	unsigned char char_array_3[3];
	unsigned char char_array_4[4];

	while (in_len--) {
	char_array_3[i++] = *(bytes_to_encode++);
	if (i == 3) {
		char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
		char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
		char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
		char_array_4[3] = char_array_3[2] & 0x3f;

		for(i = 0; (i <4) ; i++)
			ret += base64_chars[char_array_4[i]];
		i = 0;
	}
}

	if (i) {
	for(j = i; j < 3; j++)
		char_array_3[j] = '\0';

	char_array_4[0] = (char_array_3[0] & 0xfc) >> 2;
	char_array_4[1] = ((char_array_3[0] & 0x03) << 4) + ((char_array_3[1] & 0xf0) >> 4);
	char_array_4[2] = ((char_array_3[1] & 0x0f) << 2) + ((char_array_3[2] & 0xc0) >> 6);
	char_array_4[3] = char_array_3[2] & 0x3f;

	for (j = 0; (j < i + 1); j++)
		ret += base64_chars[char_array_4[j]];

	while((i++ < 3))
		ret += '=';
	}
	return ret;

}
										
Python

python 3.0을 기준으로 작성되었습니다.

HTTP 통신을 위해 urllib3 라이브러리를 사용하여 제공하고 있습니다. Python 3.0 이하의 버전에서 예제를 실행하기 위해서는 별도로 urllib3의 설치가 필요합니다. 설치에 대한 설명은 https://pypi.python.org/pypi/urllib3 를 참고하시기 바랍니다. urllib3 라이브러리에 대한 자세한 설명은 https://urllib3.readthedocs.io/en/latest/ 에서 확인 하실 수 있습니다.

#-*- coding:utf-8 -*-
import urllib3
import json
import base64
openApiURL = "http://aiopen.etri.re.kr:8000/ObjectDetect"
accessKey = "YOUR_ACCESS_KEY"
imageFilePath = "IMAGE_FILE_PATH"
type = "IMAGE_FILE_TYPE"

file = open(imageFilePath, "rb")
imageContents = base64.b64encode(file.read()).decode("utf8")
file.close()

requestJson = {
	"access_key": accessKey,
	"argument": {
		"type": type,
		"file": imageContents
	}
}

http = urllib3.PoolManager()
response = http.request(
	"POST",
	openApiURL,
	headers={"Content-Type": "application/json; charset=UTF-8"},
	body=json.dumps(requestJson)
)

print("[responseCode] " + str(response.status))
print("[responBody]")
print(response.data)
										
Node.js
var fs = require('fs');
var openApiURL = 'http://aiopen.etri.re.kr:8000/ObjectDetect';
var accessKey = 'YOUR_ACCESS_KEY';
var type = 'IMAGE_FILE_TYPE';
var imageFilePath = 'IMAGE_FILE_PATH';
var imageData;

var imageData = fs.readFileSync(imageFilePath);

var requestJson = {
	'access_key': access_key,
	'argument': {
		'type': type,
		'file': imageData.toString('base64')
	}
};

var request = require('request');
var options = {
	url: openApiURL,
	body: JSON.stringify(requestJson),
	headers: {'Content-Type':'application/json; charset=UTF-8'}
};
request.post(options, function (error, response, body) {
	console.log('responseCode = ' + response.statusCode);
	console.log('responseBody = ' + body);
});
										
객체검출 API 레퍼런스
요청 파라미터

객체검출 API에 필요한 요청 본문에 다음과 같은 파라미터를 작성해야 합니다.

[HTTP Request Body]
{
“access_key”: “YOUR_ACCESS_KEY”,
		“argument”: {
			“file”: “YOUR_file”,
			“type”: “YOUR_type”
		}
}
													

다음은 파라미터에 대한 설명입니다.

Field 명 타입 필수 여부 설명
access_key String API 사용을 위해 ETRI에서 발급한 사용자 API Key
argument Object API 사용 요청 시 분석을 위해 전달할 내용
file String 객체검출 하고자 하는 이미지를 Base64 문자열 변환한 내용

512x512 이하의 저해상도를 갖는 이미지에서는 객체 검출률이
낮아질 수 있습니다.

type String 이미지 파일의 확장자
응답

객체검출 API는 요청된 질문의 분석된 결과를 JSON 형태의 Text 데이터로 반환합니다.

다음은 정상적인 요청 처리에 대한 HTTP 응답 예입니다.

[HTTP Respone Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:50783
Content-Type:application/json; charset=UTF-8

[HTTP Respone Body]
{
		"request_id": "reserved field",
		"result": 0,
		"return_type": "com.google.gson.internal.LinkedTreeMap",
		"return_object": {객체검출 결과 JSON}
}
										

다음은 오류가 발생한 요청 처리에 대한 HTTP 응답 예입니다.

[HTTP Respone Header]
Access-Control-Allow-Origin:*
Connection:close
Content-Length:0
Content-Type:application/json; charset=UTF-8

[HTTP Respone Body]
{
		"request_id": "reserved field",
		"result": -1,
		"reason": {오류 메시지}
}
										

분석된 결과는 다음과 같은 내용이 포함되어 있습니다.

구분 JSON Key 이름 설명
객체검출
기본정보
data
class 인식 된 객체명
confidence 신뢰도
x x 좌표
y y 좌표
width 길이
height 높이

객체검출이 제대로 이루어지지 않았을 경우에는 객체인식 결과 대신 오류 메시지가 반환됩니다.

JSON Key 오류 메시지 설명
error This file is not allowed file type 파일 타입(확장자)이 ‘jpg’, ‘jpeg’, ‘png’, ‘bmp’가 아닐 경우
This file is not image contents 파일 타입(확장자)은 맞지만 입력된 파일이 실제 이미지파일이 아닐 경우
오류 코드

객체검출 API의 오류 코드 목록은 다음과 같습니다.

http status code result reason 설명
400 -1 Required arguments is empty 필수 파라미터의 값이 없는 경우
400 -1 One or more arguments are not valid 파라미터의 값이 유효하지 않는 경우
413 -1 Request Entity Too Large 요청 문장 또는 어휘의 크기가 서버가 처리 할 수 있는 것보다 큰 경우
429 -1 Too Many Requests 사용자가 주어진 시간 내에 서버에 너무 많은 요청을 하는 경우
404 -1 Unknown Handler 등록되지 않는 서비스를 요청한 경우
408 -1 Handler Timeout 서버의 요청 대기가 시간을 초과한 경우
500 -1 ETRI service server connection refused ETRI 분석 서버에서 요청을 받지 못하는 경우
500 -1 ETRI service server is not exists 수행 가능한 ETRI 분석 서버가 없는 경우
500 -1 Recipient Failure ETRI 분석 서버에서 요청을 처리하지 못하는 경우
500 -1 Unknown ReplyFailure API 요청에 알 수 없는 내부 오류가 발생한 경우
500 -1 Unknown Exception 알 수 없는 내부 오류가 발생한 경우