clwoz-models/src/Score.ts

Models for ConversationLearner

/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import { ActionTypes, ActionBase } from './Action'
import { Metrics } from './Metrics'
import { FilledEntity } from './FilledEntity'

export interface ScoreInput {
  filledEntities: FilledEntity[]
  context: {}
  maskedActions: string[]
}

export interface ScoredBase {
  actionId: string
  payload: string
  isTerminal: boolean
  actionType: ActionTypes
}

export interface UnscoredAction extends ScoredBase {
  reason: string
}

export interface ScoredAction extends ScoredBase {
  score: number
}

export interface ScoreResponse {
  scoredActions: ScoredAction[]
  unscoredActions: UnscoredAction[]
  metrics: Metrics
  scoreContext?: ScoreContext
}

export interface ScoreContext {
  previousAction: ActionBase
}