Recommendation API는 고객이 요청한 상품 Code를 기준으로 유사한 상품을 추천하여 전달합니다.
GET, POST 방식을 모두 지원하므로 원하는 방식을 선택하여 사용할 수 있습니다.
Endpoint
현재 지원되고 있는 Lens API Version은 두가지가 있습니다
Version 1.1:
Version 1.2
1.1 이랑 비교해서 Recommendation API Request 에 Filter 기능이 추가되었습니다
Version 1.3: 신규로 Lens를 사용하시는 경우 해당 Version 사용하시는 것을 추천드립니다
1.2 와 비교해서 Recommendation API Request 에 Metadata Filter 기능이 추가되었습니다
방식 1. GET /
요청 형식
Header
Name
Description
x-api-key
{omnious 로 부터 발급 받은 API Key} [Required]
Query Parameter
Name
Type
Description
id
String
(필수) 추천을 원하는 기준 상품의 상품 code
limit
Int
추천할 항목의 최대 수량
기본값: 10
최대값: 500
weightColorFeature
String
추천에 색상을 얼마나 반영할지 여부
기본값: MEDIUM
다음 값 중에서 선택가능
LOW
MEDIUM
HIGH
showContext
Bool
Context 정보를 표시할지 여부
기본값: false
showImageInfo
Bool
Image 정보를 표시할지 여부
기본값: false
mfilter
String
메타데이터 필터는 v1.3에서 사용하실 수 있습니다.
metadata filter
문자열에 작은 따옴표(')나 큰따옴표(“)로 감싸야 합니
연산자
정의
문자열
숫자
날짜
예제
and
query 연결
O
O
O
price gt 1000 and price lt 10000
eq
=
O
O
O
brand eq 'nike'
ne
!=
O
O
O
brand ne 'nike'
ge
>=
X
O
O
price ge 1000
gt
>
X
O
O
datetime gt 2021-01-01
le
<=
X
O
O
datetime le 2021-01-01T00:00:00
lt
<
X
O
O
price lt 10000
in
in (포함관계)
O
O
O
brand in ('nike', 'adidas')
like
유사관계
O
X
X
productName like 'skirt'
요청 Example
Example1. Context 정보 없이 요청
curl --location --request GET 'https://api.omnious.com/lens/v1.1/recommend?id=725447&limit=10&weightColorFeature=MEDIUM' \
--header 'x-api-key: <<API-KEY>>'
Example2. Context 정보와 함께 요청
curl --location --request GET 'https://api.omnious.com/lens/v1.1/recommend?id=725447&limit=10&weightColorFeature=MEDIUM&showContext=true' \
--header 'x-api-key: <<API-KEY>>'
Example3. Context 정보, Image 정보와 함께 요청
curl --location --request GET 'https://api.omnious.com/lens/v1.1/recommend?id=725447&limit=10&weightColorFeature=MEDIUM&showContext=true&showImageInfo=true' \
--header 'x-api-key: <<API-KEY>>'
Example4.(metadata filter) price가 1000보다 크고 10000보다 낮으며, datetime이 2021-01-01보다 크고, color이 white와 black 중 하나인 경우
curl --location --request GET 'https://api.omnious.com/lens/v1.3/recommend?id=725447&limit=10&weightColorFeature=MEDIUM&showContext=true&showImageInfo=true&mfilter=price gt 1000 and price le 10000 and datetime gt 2021-01-01 and color in ('white', 'black') \
--header 'x-api-key: <<API-KEY>>'
응답 형식
추천된 상품을 유사도 순으로 반환합니다.
HTTP Status Code
Code
Description
403
API KEY 인증과 관련된 오류
400
입력 값 Validation 진행중 발생한 오류
200
성공적으로 추천 결과를 리턴하였지만 추천된 상품 정보가 없는 경우
201
성공적으로 추천 결과를 리턴하였고 추천된 상품 정보가 있는 경우
500
서버 오류
Response Data
Name
Type
Description
id
String
기준이 되는 상품 code
limit
Int
추천할 항목의 최대 수량
weightColorFeature
String
추천에 색상을 얼마나 반영할지 여부
[LOW | MEDIUM | HIGH]
showContext
Bool
Context 정보를 표시할지 여부
showImageInfo
Bool
Image 정보를 표시할지 여부
recommendation
Array of Recommendation
추천 항목 (아래 참조)
Recommendation
Name
Type
Description
id
String
추천할 상품 code
url
String
추천할 상품 정보 url
context
Object
Data Management API 에서 입력했던 context 정보
imageInfo
Object
Data Management API 에서 입력했던 image 정보
(Detection 정보, Image URL)
Example9. (metadata filter) price가 1000보다 크고 10000보다 낮으며, datetime이 2021-01-01보다 크고, color가 white와 black 중 하나인 경우
{
"id": "725447",
"limit": 10,
"weightColorFeature": "MEDIUM",
"showContext": true,
"showImageInfo": true,
"mfilter": "price gt 1000 and price le 10000 and datetime gt 2021-01-01 and color in ('white', 'black')"
}
