Type Alias NLMetricRecord

type NLMetricRecord = {
    appId: string;
    appName?: string;
    apps?: AppMetadata[];
    channelId?: string;
    chartType?: string;
    createdAt: string;
    createdBy?: string;
    feedback?: RecFeedback[];
    id: string;
    isContextualQuery?: boolean;
    lang?: string;
    nluInfo?: PartialNluInfo[];
    queryError?: boolean;
    queryOrigin?: "askQuestion" | "iaAnalysis" | "iaAssetsPanel";
    queryText?: string;
    queryType?:
        | "appList"
        | "appSuggested"
        | "dimensionList"
        | "exploreThisFurther"
        | "followup"
        | "greetings"
        | "measureList"
        | "query"
        | "sampleQuestion";
    questionId: string;
    recommendations?: NLMetricRecommendation[];
    responses?: NLResponses;
    stopWords?: string[];
    tenantId?: string;
    unmatchedEntities?: string[];
    updatedAt: string;
    version: string;
}
Index

Properties

appId appName? apps? channelId? chartType? createdAt createdBy? feedback? id isContextualQuery? lang? nluInfo? queryError? queryOrigin? queryText? queryType? questionId recommendations? responses? stopWords? tenantId? unmatchedEntities? updatedAt version

Properties

appId: string

Qlik sense app id that is being used to answer the question

appName?: string

Qlik sense app name that is being used to answer the question

apps?: AppMetadata[]
channelId?: string

Source from which conversation is happening

chartType?: string

Chart type for given query. For insight advisor it would be 'native' and for insight advisor chat, it could be 'static' or 'responsive'

createdAt: string

Record created date

createdBy?: string

Qlik sense user id who is interacting with insight advisor or insight advisor chat or third party api

feedback?: RecFeedback[]
id: string

Unique record id stored in database

isContextualQuery?: boolean

Boolean value indicates whether given query is contextual or not. It would be false for insight advisor

lang?: string

language selected for query from insight advisor or insight advisor chat or third party api

nluInfo?: PartialNluInfo[]
queryError?: boolean
queryOrigin?: "askQuestion" | "iaAnalysis" | "iaAssetsPanel"

Refers to source from where narrative request is called

queryText?: string

Query asked by user in insight advisor or insight advisor or third party api

queryType?:
    | "appList"
    | "appSuggested"
    | "dimensionList"
    | "exploreThisFurther"
    | "followup"
    | "greetings"
    | "measureList"
    | "query"
    | "sampleQuestion"

Nature of query being asked during the conversation e.g. query, applist, measurelist, dimensionlist

questionId: string

Unique id assigned to user query

recommendations?: NLMetricRecommendation[]
responses?: NLResponses

Provides info what was included in response for given query

stopWords?: string[]

Tokens from question parsed which are ignored

tenantId?: string

Qlik sense tenant Id

unmatchedEntities?: string[]

Tokens parsed as entities but not matched with app's field/dimension/measure

updatedAt: string

Record modified date

version: string

Version of the metric model

Settings

Member Visibility

On This Page

Properties