@stacksjs/ts-cloud 0.1.2 → 0.1.5

package/dist/aws/personalize.d.ts

@@ -0,0 +1,516 @@
+import { AWSClient } from './client';
+/**
+ * Get recommendations for a user
+ */
+export declare function getRecommendations(campaignArn: string, userId: string, options?: { numResults?: number; region?: string }): Promise<string[]>;
+/**
+ * Get similar items
+ */
+export declare function getSimilarItems(campaignArn: string, itemId: string, options?: { numResults?: number; region?: string }): Promise<string[]>;
+/**
+ * Track user event
+ */
+export declare function trackEvent(trackingId: string, sessionId: string, userId: string, itemId: string, eventType?: string, region?: string): Promise<void>;
+// ============================================================================
+// Types
+// ============================================================================
+export declare interface CreateDatasetGroupCommandInput {
+  name: string
+  roleArn?: string
+  kmsKeyArn?: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateDatasetGroupCommandOutput {
+  datasetGroupArn?: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface DescribeDatasetGroupCommandInput {
+  datasetGroupArn: string
+}
+export declare interface DatasetGroup {
+  name?: string
+  datasetGroupArn?: string
+  status?: string
+  roleArn?: string
+  kmsKeyArn?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  failureReason?: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface DescribeDatasetGroupCommandOutput {
+  datasetGroup?: DatasetGroup
+}
+export declare interface ListDatasetGroupsCommandInput {
+  nextToken?: string
+  maxResults?: number
+}
+export declare interface DatasetGroupSummary {
+  name?: string
+  datasetGroupArn?: string
+  status?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  failureReason?: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface ListDatasetGroupsCommandOutput {
+  datasetGroups?: DatasetGroupSummary[]
+  nextToken?: string
+}
+export declare interface CreateSchemaCommandInput {
+  name: string
+  schema: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface CreateSchemaCommandOutput {
+  schemaArn?: string
+}
+export declare interface CreateDatasetCommandInput {
+  name: string
+  schemaArn: string
+  datasetGroupArn: string
+  datasetType: 'Interactions' | 'Items' | 'Users' | 'Actions' | 'Action_Interactions'
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateDatasetCommandOutput {
+  datasetArn?: string
+}
+export declare interface CreateDatasetImportJobCommandInput {
+  jobName: string
+  datasetArn: string
+  dataSource: {
+    dataLocation: string
+  }
+  roleArn: string
+  importMode?: 'FULL' | 'INCREMENTAL'
+  publishAttributionMetricsToS3?: boolean
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateDatasetImportJobCommandOutput {
+  datasetImportJobArn?: string
+}
+export declare interface DescribeDatasetImportJobCommandInput {
+  datasetImportJobArn: string
+}
+export declare interface DatasetImportJob {
+  jobName?: string
+  datasetImportJobArn?: string
+  datasetArn?: string
+  dataSource?: {
+    dataLocation?: string
+  }
+  roleArn?: string
+  status?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  failureReason?: string
+  importMode?: 'FULL' | 'INCREMENTAL'
+  publishAttributionMetricsToS3?: boolean
+}
+export declare interface DescribeDatasetImportJobCommandOutput {
+  datasetImportJob?: DatasetImportJob
+}
+export declare interface CreateSolutionCommandInput {
+  name: string
+  datasetGroupArn: string
+  recipeArn?: string
+  eventType?: string
+  solutionConfig?: {
+    eventValueThreshold?: string
+    hpoConfig?: {
+      hpoObjective?: {
+        type?: string
+        metricName?: string
+        metricRegex?: string
+      }
+      hpoResourceConfig?: {
+        maxNumberOfTrainingJobs?: string
+        maxParallelTrainingJobs?: string
+      }
+      algorithmHyperParameterRanges?: {
+        integerHyperParameterRanges?: Array<{
+          name?: string
+          minValue?: number
+          maxValue?: number
+        }>
+        continuousHyperParameterRanges?: Array<{
+          name?: string
+          minValue?: number
+          maxValue?: number
+        }>
+        categoricalHyperParameterRanges?: Array<{
+          name?: string
+          values?: string[]
+        }>
+      }
+    }
+    algorithmHyperParameters?: Record<string, string>
+    featureTransformationParameters?: Record<string, string>
+    autoMLConfig?: {
+      metricName?: string
+      recipeList?: string[]
+    }
+    optimizationObjective?: {
+      itemAttribute?: string
+      objectiveSensitivity?: 'LOW' | 'MEDIUM' | 'HIGH' | 'OFF'
+    }
+    trainingDataConfig?: {
+      excludedDatasetColumns?: Record<string, string[]>
+    }
+  }
+  performHPO?: boolean
+  performAutoML?: boolean
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateSolutionCommandOutput {
+  solutionArn?: string
+}
+export declare interface CreateSolutionVersionCommandInput {
+  name?: string
+  solutionArn: string
+  trainingMode?: 'FULL' | 'UPDATE' | 'AUTOTRAIN'
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateSolutionVersionCommandOutput {
+  solutionVersionArn?: string
+}
+export declare interface DescribeSolutionVersionCommandInput {
+  solutionVersionArn: string
+}
+export declare interface SolutionVersion {
+  name?: string
+  solutionVersionArn?: string
+  solutionArn?: string
+  performHPO?: boolean
+  performAutoML?: boolean
+  recipeArn?: string
+  eventType?: string
+  datasetGroupArn?: string
+  solutionConfig?: {
+    eventValueThreshold?: string
+    hpoConfig?: Record<string, unknown>
+    algorithmHyperParameters?: Record<string, string>
+    featureTransformationParameters?: Record<string, string>
+    autoMLConfig?: Record<string, unknown>
+  }
+  trainingHours?: number
+  trainingMode?: 'FULL' | 'UPDATE' | 'AUTOTRAIN'
+  tunedHPOParams?: {
+    algorithmHyperParameters?: Record<string, string>
+  }
+  status?: string
+  failureReason?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  trainingType?: 'AUTOMATIC' | 'MANUAL'
+}
+export declare interface DescribeSolutionVersionCommandOutput {
+  solutionVersion?: SolutionVersion
+}
+export declare interface CreateCampaignCommandInput {
+  name: string
+  solutionVersionArn: string
+  minProvisionedTPS?: number
+  campaignConfig?: {
+    itemExplorationConfig?: Record<string, string>
+    enableMetadataWithRecommendations?: boolean
+    syncWithLatestSolutionVersion?: boolean
+  }
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateCampaignCommandOutput {
+  campaignArn?: string
+}
+export declare interface DescribeCampaignCommandInput {
+  campaignArn: string
+}
+export declare interface Campaign {
+  name?: string
+  campaignArn?: string
+  solutionVersionArn?: string
+  minProvisionedTPS?: number
+  campaignConfig?: {
+    itemExplorationConfig?: Record<string, string>
+    enableMetadataWithRecommendations?: boolean
+    syncWithLatestSolutionVersion?: boolean
+  }
+  status?: string
+  failureReason?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  latestCampaignUpdate?: {
+    solutionVersionArn?: string
+    minProvisionedTPS?: number
+    campaignConfig?: Record<string, unknown>
+    status?: string
+    failureReason?: string
+    creationDateTime?: string
+    lastUpdatedDateTime?: string
+  }
+}
+export declare interface DescribeCampaignCommandOutput {
+  campaign?: Campaign
+}
+export declare interface GetRecommendationsCommandInput {
+  campaignArn?: string
+  recommenderArn?: string
+  itemId?: string
+  userId?: string
+  numResults?: number
+  context?: Record<string, string>
+  filterArn?: string
+  filterValues?: Record<string, string>
+  promotions?: Array<{
+    name?: string
+    percentPromotedItems?: number
+    filterArn?: string
+    filterValues?: Record<string, string>
+  }>
+  metadataColumns?: Record<string, string[]>
+}
+export declare interface PredictedItem {
+  itemId?: string
+  score?: number
+  promotionName?: string
+  metadata?: Record<string, string>
+  reason?: string[]
+}
+export declare interface GetRecommendationsCommandOutput {
+  itemList?: PredictedItem[]
+  recommendationId?: string
+}
+export declare interface GetPersonalizedRankingCommandInput {
+  campaignArn: string
+  inputList: string[]
+  userId: string
+  context?: Record<string, string>
+  filterArn?: string
+  filterValues?: Record<string, string>
+  metadataColumns?: Record<string, string[]>
+}
+export declare interface GetPersonalizedRankingCommandOutput {
+  personalizedRanking?: PredictedItem[]
+  recommendationId?: string
+}
+export declare interface CreateRecommenderCommandInput {
+  name: string
+  datasetGroupArn: string
+  recipeArn: string
+  recommenderConfig?: {
+    itemExplorationConfig?: Record<string, string>
+    minRecommendationRequestsPerSecond?: number
+    trainingDataConfig?: {
+      excludedDatasetColumns?: Record<string, string[]>
+    }
+    enableMetadataWithRecommendations?: boolean
+  }
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateRecommenderCommandOutput {
+  recommenderArn?: string
+}
+export declare interface DescribeRecommenderCommandInput {
+  recommenderArn: string
+}
+export declare interface Recommender {
+  recommenderArn?: string
+  datasetGroupArn?: string
+  name?: string
+  recipeArn?: string
+  recommenderConfig?: {
+    itemExplorationConfig?: Record<string, string>
+    minRecommendationRequestsPerSecond?: number
+    trainingDataConfig?: {
+      excludedDatasetColumns?: Record<string, string[]>
+    }
+    enableMetadataWithRecommendations?: boolean
+  }
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  status?: string
+  failureReason?: string
+  latestRecommenderUpdate?: {
+    recommenderConfig?: Record<string, unknown>
+    creationDateTime?: string
+    lastUpdatedDateTime?: string
+    status?: string
+    failureReason?: string
+  }
+  modelMetrics?: Record<string, number>
+}
+export declare interface DescribeRecommenderCommandOutput {
+  recommender?: Recommender
+}
+export declare interface ListRecommendersCommandInput {
+  datasetGroupArn?: string
+  nextToken?: string
+  maxResults?: number
+}
+export declare interface RecommenderSummary {
+  name?: string
+  recommenderArn?: string
+  datasetGroupArn?: string
+  recipeArn?: string
+  recommenderConfig?: Record<string, unknown>
+  status?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+}
+export declare interface ListRecommendersCommandOutput {
+  recommenders?: RecommenderSummary[]
+  nextToken?: string
+}
+export declare interface PutEventsCommandInput {
+  trackingId: string
+  userId?: string
+  sessionId: string
+  eventList: Array<{
+    eventId?: string
+    eventType: string
+    eventValue?: number
+    itemId?: string
+    properties?: string
+    sentAt: Date | string
+    recommendationId?: string
+    impression?: string[]
+    metricAttribution?: {
+      eventAttributionSource?: string
+    }
+  }>
+}
+export declare interface PutEventsCommandOutput {
+
+}
+export declare interface PutItemsCommandInput {
+  datasetArn: string
+  items: Array<{
+    itemId: string
+    properties?: string
+  }>
+}
+export declare interface PutItemsCommandOutput {
+
+}
+export declare interface PutUsersCommandInput {
+  datasetArn: string
+  users: Array<{
+    userId: string
+    properties?: string
+  }>
+}
+export declare interface PutUsersCommandOutput {
+
+}
+export declare interface CreateEventTrackerCommandInput {
+  name: string
+  datasetGroupArn: string
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateEventTrackerCommandOutput {
+  eventTrackerArn?: string
+  trackingId?: string
+}
+export declare interface DescribeEventTrackerCommandInput {
+  eventTrackerArn: string
+}
+export declare interface EventTracker {
+  name?: string
+  eventTrackerArn?: string
+  accountId?: string
+  trackingId?: string
+  datasetGroupArn?: string
+  status?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+}
+export declare interface DescribeEventTrackerCommandOutput {
+  eventTracker?: EventTracker
+}
+export declare interface CreateFilterCommandInput {
+  name: string
+  datasetGroupArn: string
+  filterExpression: string
+  tags?: Array<{ tagKey: string; tagValue: string }>
+}
+export declare interface CreateFilterCommandOutput {
+  filterArn?: string
+}
+export declare interface ListRecipesCommandInput {
+  recipeProvider?: 'SERVICE'
+  nextToken?: string
+  maxResults?: number
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface RecipeSummary {
+  name?: string
+  recipeArn?: string
+  status?: string
+  creationDateTime?: string
+  lastUpdatedDateTime?: string
+  domain?: 'ECOMMERCE' | 'VIDEO_ON_DEMAND'
+}
+export declare interface ListRecipesCommandOutput {
+  recipes?: RecipeSummary[]
+  nextToken?: string
+}
+// ============================================================================
+// Personalize Client
+// ============================================================================
+export declare class PersonalizeClient {
+  private client: AWSClient;
+  private region: string;
+  constructor(region?: string);
+  private request<T>(action: string, params: Record<string, unknown>): Promise<T>;
+  createDatasetGroup(params: CreateDatasetGroupCommandInput): Promise<CreateDatasetGroupCommandOutput>;
+  describeDatasetGroup(params: DescribeDatasetGroupCommandInput): Promise<DescribeDatasetGroupCommandOutput>;
+  listDatasetGroups(params?: ListDatasetGroupsCommandInput): Promise<ListDatasetGroupsCommandOutput>;
+  createSchema(params: CreateSchemaCommandInput): Promise<CreateSchemaCommandOutput>;
+  createDataset(params: CreateDatasetCommandInput): Promise<CreateDatasetCommandOutput>;
+  createDatasetImportJob(params: CreateDatasetImportJobCommandInput): Promise<CreateDatasetImportJobCommandOutput>;
+  describeDatasetImportJob(params: DescribeDatasetImportJobCommandInput): Promise<DescribeDatasetImportJobCommandOutput>;
+  createSolution(params: CreateSolutionCommandInput): Promise<CreateSolutionCommandOutput>;
+  createSolutionVersion(params: CreateSolutionVersionCommandInput): Promise<CreateSolutionVersionCommandOutput>;
+  describeSolutionVersion(params: DescribeSolutionVersionCommandInput): Promise<DescribeSolutionVersionCommandOutput>;
+  createCampaign(params: CreateCampaignCommandInput): Promise<CreateCampaignCommandOutput>;
+  describeCampaign(params: DescribeCampaignCommandInput): Promise<DescribeCampaignCommandOutput>;
+  createRecommender(params: CreateRecommenderCommandInput): Promise<CreateRecommenderCommandOutput>;
+  describeRecommender(params: DescribeRecommenderCommandInput): Promise<DescribeRecommenderCommandOutput>;
+  listRecommenders(params?: ListRecommendersCommandInput): Promise<ListRecommendersCommandOutput>;
+  createEventTracker(params: CreateEventTrackerCommandInput): Promise<CreateEventTrackerCommandOutput>;
+  describeEventTracker(params: DescribeEventTrackerCommandInput): Promise<DescribeEventTrackerCommandOutput>;
+  createFilter(params: CreateFilterCommandInput): Promise<CreateFilterCommandOutput>;
+  listRecipes(params?: ListRecipesCommandInput): Promise<ListRecipesCommandOutput>;
+  waitForSolutionVersion(solutionVersionArn: string, options?: { maxWaitMs?: number; pollIntervalMs?: number }): Promise<SolutionVersion>;
+  waitForCampaign(campaignArn: string, options?: { maxWaitMs?: number; pollIntervalMs?: number }): Promise<Campaign>;
+  waitForDatasetImportJob(jobArn: string, options?: { maxWaitMs?: number; pollIntervalMs?: number }): Promise<DatasetImportJob>;
+}
+// ============================================================================
+// Personalize Runtime Client (for getting recommendations)
+// ============================================================================
+export declare class PersonalizeRuntimeClient {
+  private client: AWSClient;
+  private region: string;
+  constructor(region?: string);
+  private request<T>(action: string, params: Record<string, unknown>): Promise<T>;
+  getRecommendations(params: GetRecommendationsCommandInput): Promise<GetRecommendationsCommandOutput>;
+  getPersonalizedRanking(params: GetPersonalizedRankingCommandInput): Promise<GetPersonalizedRankingCommandOutput>;
+  recommendForUser(campaignArn: string, userId: string, numResults?: number): Promise<string[]>;
+  getSimilarItems(campaignArn: string, itemId: string, numResults?: number): Promise<string[]>;
+  rankItems(campaignArn: string, userId: string, itemIds: string[]): Promise<string[]>;
+}
+// ============================================================================
+// Personalize Events Client
+// ============================================================================
+export declare class PersonalizeEventsClient {
+  private client: AWSClient;
+  private region: string;
+  constructor(region?: string);
+  private request<T>(action: string, params: Record<string, unknown>): Promise<T>;
+  putEvents(params: PutEventsCommandInput): Promise<PutEventsCommandOutput>;
+  putItems(params: PutItemsCommandInput): Promise<PutItemsCommandOutput>;
+  putUsers(params: PutUsersCommandInput): Promise<PutUsersCommandOutput>;
+  trackEvent(trackingId: string, sessionId: string, userId: string, itemId: string, eventType?: string): Promise<void>;
+  trackPurchase(trackingId: string, sessionId: string, userId: string, itemId: string, value: number): Promise<void>;
+}