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