GetRecommendationsRequest

import type { GetRecommendationsRequest } from "https://aws-api.deno.dev/v0.3/services/personalizeruntime.ts?docs=full";

interface GetRecommendationsRequest {

campaignArn?: string | null;

context?: {

[key: string]: string | null | undefined;

} | null;

filterArn?: string | null;

filterValues?: {

[key: string]: string | null | undefined;

} | null;

itemId?: string | null;

numResults?: number | null;

recommenderArn?: string | null;

userId?: string | null;

}

§Properties

campaignArn?: string | null

[src]

The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.

context?: {

[key: string]: string | null | undefined;

} | null

[src]

The contextual metadata to use when getting recommendations. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type.

filterArn?: string | null

[src]

The ARN of the filter to apply to the returned recommendations. For more information, see Filtering Recommendations.

When using this parameter, be sure the filter resource is ACTIVE.

filterValues?: {

[key: string]: string | null | undefined;

} | null

[src]

The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.

For filter expressions that use an INCLUDE element to include items, you must provide values for all parameters that are defined in the expression. For filters with expressions that use an EXCLUDE element to exclude items, you can omit the filter-values.In this case, Amazon Personalize doesn't use that portion of the expression to filter recommendations.

For more information, see Filtering Recommendations.

itemId?: string | null

[src]

The item ID to provide recommendations for.

Required for RELATED_ITEMS recipe type.

numResults?: number | null

[src]

The number of results to return. The default is 25. The maximum is 500.

recommenderArn?: string | null

[src]

The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you created a Domain dataset group with a recommender for a domain use case.

userId?: string | null

[src]

The user ID to provide recommendations for.

Required for USER_PERSONALIZATION recipe type.