// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

// Quantity must be a number, do not infer amounts.
export type Quantity = {
    amount: number;
    units: string;
};

// String quantifier, e.g. 'many', 'few', 'several', 'a lot of', 'some'.
export type Quantifier = {
    amount: string;
    units: string;
};

export type Value = string | number | boolean | Quantity | Quantifier;

export type Facet = {
    name: string;
    // Very concise values.
    value: Value;
};

// Specific, tangible people, places, institutions or things only
export type ConcreteEntity = {
    // the name of the entity or thing such as "Bach", "Great Gatsby", "frog" or "piano"
    name: string;
    // the types of the entity such as "speaker", "person", "artist", "animal", "object", "instrument", "school", "room", "museum", "food" etc.
    // An entity can have multiple types; entity types should be single words
    type: string[];
    // A specific, inherent, defining, or non-immediate facet of the entity such as "blue", "old", "famous", "sister", "aunt_of", "weight: 4 kg"
    // trivial actions or state changes are not facets
    // facets are concise "properties"
    facets?: Facet[];
};

export type ActionParam = {
    name: string;
    value: Value;
};

export type VerbTense = "past" | "present" | "future";

export type Action = {
    // Each verb is typically a word.
    verbs: string[];
    verbTense: VerbTense;
    // Some actions can ALSO be expressed in a reverse way. Examples:
    // "A gave B" has the inverse "B received from A"
    // "A said to B" has the inverse "B heard A"
    // "A saw B" has the inverse "B seen by A"
    // If so, also return the inverse form of the verbs, without verb tenses
    inverseVerbs: string[];
    subjectEntityName: string | "none";
    objectEntityName: string | "none";
    indirectObjectEntityName: string | "none";
    params?: (string | ActionParam)[];
    // If the action implies this additional facet or property of the subjectEntity, such as hobbies, activities, interests, personality
    subjectEntityFacet?: Facet | undefined;
};

// Detailed and comprehensive knowledge response
export type KnowledgeResponse = {
    entities: ConcreteEntity[];
    // The 'subjectEntityName' and 'objectEntityName' must correspond to the 'name' of an entity listed in the 'entities' array.
    actions: Action[];
    // Detailed, descriptive topics and keyword.
    topics: string[];
};
