Class RecommendationProviderBase`Abstract`

Base class for all recommendation providers

Hierarchy

RecommendationProviderBase

Index

Constructors

Properties

_ContextUser _md

Accessors

Methods

Recommend SaveRecommendation

Constructors

constructor

new RecommendationProviderBase(ContextUser): RecommendationProviderBase
Parameters
- ContextUser: UserInfo
Returns RecommendationProviderBase
- Defined in AI/Recommendations/Engine/src/ProviderBase.ts:12

Properties

`Private` _ContextUser

_ContextUser: UserInfo

`Private` _md

Accessors

ContextUser

get ContextUser(): UserInfo
Returns UserInfo
- Defined in AI/Recommendations/Engine/src/ProviderBase.ts:17

Methods

`Abstract` Recommend

Recommend(request): Promise<RecommendationResult>
For each entry in the request.Recommendations array, the provider's external API is called to produce zero or more RecommendationItemEntity records.
Parameters
- request: RecommendationRequest<Record<string, any>>
  The Recommendations to request from this provider
Returns Promise<RecommendationResult>
- Defined in AI/Recommendations/Engine/src/ProviderBase.ts:27

`Protected` SaveRecommendation

SaveRecommendation(recommendation, RunID, items): Promise<boolean>
This method is used by subclasses to update a Recommendation record in the database to set the RecommendationRunID column. In addition, this method will save all the RecommendationItem records associated with the Recommendation record and link them to the Recommendation record.
Parameters
- recommendation: RecommendationEntity
- RunID: string
- items: RecommendationItemEntity[]
Returns Promise<boolean>
- Defined in AI/Recommendations/Engine/src/ProviderBase.ts:35