기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
GetRecommendations
권장 항목 목록을 반환합니다. 캠페인의 경우 캠페인의 Amazon Resource Name (ARN) 이 필요하며 필요한 사용자 및 항목 입력은 다음과 같이 캠페인을 지원하는 솔루션을 생성하는 데 사용된 레시피 유형에 따라 달라집니다.
-
사용자_맞춤 설정 -
userId
필수, 사용되지itemId
않음 -
관련 항목 -
itemId
필수, 사용되지userId
않음
참고
PERSONALIZED_RANKING 유형의 레시피를 사용하여 만든 솔루션으로 뒷받침되는 캠페인은GetPersonalizedRanking API를 사용합니다.
추천자의 경우 추천자의 ARN이 필요하며 필수 항목 및 사용자 입력은 추천자를 지원하는 사용 사례 (도메인 기반 레시피) 에 따라 달라집니다. 사용 사례 요구 사항에 대한 자세한 내용은 권장 사용 사례 선택을 참조하십시오.
요청 구문
POST /recommendations HTTP/1.1
Content-type: application/json
{
"campaignArn": "string
",
"context": {
"string
" : "string
"
},
"filterArn": "string
",
"filterValues": {
"string
" : "string
"
},
"itemId": "string
",
"numResults": number
,
"promotions": [
{
"filterArn": "string
",
"filterValues": {
"string
" : "string
"
},
"name": "string
",
"percentPromotedItems": number
}
],
"recommenderArn": "string
",
"userId": "string
"
}
URI 요청 파라미터
요청은 URI 파라미터를 사용하지 않습니다.
요청 본문
요청은 JSON 형식의 다음 데이터를 받습니다.
- campaignArn
-
추천을 받는 데 사용할 Amazon 리소스 이름 (ARN) 입니다.
유형: String
길이 제약: 최대 길이는 256입니다.
패턴:
arn:([a-z\d-]+):personalize:.*:.*:.+
필수 항목 여부: 아니요
- context
-
추천을 받을 때 사용할 컨텍스트 메타데이터입니다. 컨텍스트 메타데이터에는 사용자의 현재 위치나 기기 유형과 같이 사용자의 추천을 받을 때 관련성이 있을 수 있는 모든 상호 작용 정보가 포함됩니다.
유형: String 간 맵
맵 항목: 최대 항목 수는 150개입니다.
키 길이 제약: 최대 길이는 1508입니다.
키 패턴:
[A-Za-z\d_]+
값 길이 제약: 최대 길이는 1,0001,000입니다.
필수 항목 여부: 아니요
- filterArn
-
반환된 권장 사항에 적용할 필터의 ARN입니다. 자세한 내용은 권장 사항 필터링 단원을 참조하십시오.
이 매개 변수를 사용할 때는 필터 리소스가 맞는지 확인하십시오
ACTIVE
.유형: String
길이 제약: 최대 길이는 256입니다.
패턴:
arn:([a-z\d-]+):personalize:.*:.*:.+
필수 항목 여부: 아니요
- filterValues
-
권장 사항을 필터링할 때 사용할 값입니다. 필터 표현식의 각 자리 표시자 매개 변수에 대해 매개 변수 이름 (대/소문자 일치) 을 키로, 필터 값을 해당 값으로 제공합니다. 한 매개변수의 여러 값을 쉼표로 구분합니다.
INCLUDE
요소를 사용하여 항목을 포함하는 필터 표현식의 경우 표현식에 정의된 모든 매개 변수의 값을 제공해야 합니다.EXCLUDE
요소를 사용하여 항목을 제외하는 식이 있는 필터의 경우filter-values
.를 생략할 수 있습니다. 이 경우 Amazon Personalize 표현식의 해당 부분을 사용하여 권장 사항을 필터링하지 않습니다.자세한 내용은 권장 항목 및 사용자 세그먼트 필터링 단원을 참조하십시오.
유형: String 간 맵
맵 항목: 최대 항목 수는 25개입니다.
키 길이 제약: 최대 길이는 5088입니다.
키 패턴:
[A-Za-z0-9_]+
값 길이 제약: 최대 길이는 1,0001,000입니다.
필수 항목 여부: 아니요
- itemId
-
권장 사항을 제공할 항목 ID입니다.
RELATED_ITEMS
레시피 유형에 필요합니다.유형: String
길이 제약: 최대 길이는 256입니다.
필수 항목 여부: 아니요
- numResults
-
반환할 반환할 수입니다. 기본값은 25입니다. 최대 값은 500입니다.
Type: 정수
유효한 범위: 최소값 0.
필수 항목 여부: 아니요
- promotions
-
추천 요청에 적용할 프로모션입니다. 프로모션은 구성 가능한 권장 항목 하위 집합에 적용되는 추가 비즈니스 규칙을 정의합니다.
유형: Promotion 객체 배열
배열 멤버: 최대 항목 수는 1개입니다.
필수 항목 여부: 아니요
- recommenderArn
-
추천을 받는 데 사용할 Amazon 리소스 이름 (ARN) 입니다. 도메인 사용 사례에 대한 추천자와 함께 도메인 데이터세트 그룹을 만든 경우 추천자 ARN을 제공하세요.
유형: String
길이 제약: 최대 길이는 256입니다.
패턴:
arn:([a-z\d-]+):personalize:.*:.*:.+
필수 항목 여부: 아니요
- userId
-
추천을 제공할 사용자 ID입니다.
USER_PERSONALIZATION
레시피 유형에 필요합니다.유형: String
길이 제약: 최대 길이는 256입니다.
필수 항목 여부: 아니요
응답 구문
HTTP/1.1 200
Content-type: application/json
{
"itemList": [
{
"itemId": "string",
"promotionName": "string",
"score": number
}
],
"recommendationId": "string"
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 다시 전송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- itemList
-
예측 점수를 기준으로 내림차순으로 정렬된 추천 목록입니다. 목록에는 최대 500개의 항목이 있을 수 있습니다.
유형: PredictedItem 객체 배열
- recommendationId
-
추천의 ID입니다.
유형: String
오류
- InvalidInputException
-
필드 또는 파라미터에 유효한 값을 입력합니다.
HTTP 상태 코드: 400
- ResourceNotFoundException
-
지정한 리소스가 존재하지 않습니다.
HTTP 상태 코드: 404
참고 항목
이 API를 언어별 AWS SDK 중 하나로 사용하는 방법에 대한 자세한 내용은 다음을 참조하세요.