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