Class RecommendationResult

This response is generated for each Recommend() request

Index

Constructors

Properties

ErrorMessage RecommendationItems? RecommendationRun? Request Success

Methods

AppendError AppendWarning GetErrorMessages

Constructors

constructor

new RecommendationResult(request: RecommendationRequest): RecommendationResult
Parameters
- request: RecommendationRequest
Returns RecommendationResult
- Defined in AI/Recommendations/Engine/src/generic/types.ts:83

Properties

ErrorMessage

ErrorMessage: string

`Optional`RecommendationItems

RecommendationItems?: MJRecommendationItemEntity[] = []

The Recommendation Item Entities that were created by the recommendation provider

`Optional`RecommendationRun

RecommendationRun?: MJRecommendationRunEntity

The Recommendation Run entity that was created by the recommendation engine

Request

Request: RecommendationRequest

Success

Success: boolean

Methods

AppendError

AppendError(errorMessage: string): void
Appends the provided errorMessage param to the ErrorMessage property, with "Error: " prepended to the message and a newline character appended to the end. Also sets the Success property to false.
Parameters
- errorMessage: string
Returns void
- Defined in AI/Recommendations/Engine/src/generic/types.ts:103

AppendWarning

AppendWarning(warningMessage: string): void
Appends the provided warningMessage param to the ErrorMessage property, with "Warning: " prepended to the message and a newline character appended to the end. The value of the Success property is not changed.
Parameters
- warningMessage: string
Returns void
- Defined in AI/Recommendations/Engine/src/generic/types.ts:94

GetErrorMessages

GetErrorMessages(): string[]
Returns the ErrorMessage property as an array of strings. Useful in the event multiple errors or warnings were produced during the recommendation run.

Returns string[]
- Defined in AI/Recommendations/Engine/src/generic/types.ts:113