@or-sdk/knowledge-models 0.12.0

package/dist/types/types.d.ts

@@ -0,0 +1,306 @@
+import { Token } from '@or-sdk/base';
+export declare type KnowledgeModelsConfig = {
+    token: Token;
+    discoveryUrl: string;
+};
+export declare type Version = {
+    versionId: string;
+    trainStatus: {
+        status: string;
+        message: string;
+        modelId: string;
+        date: number;
+    };
+    prebuiltModelIds?: string[];
+};
+export declare type KnowledgeModel = {
+    extensions: string[];
+    name: string;
+    desc: string;
+    imageSrc: string;
+    createdBy: string;
+    createdDate: number;
+    modifiedBy: string;
+    modifiedDate: number;
+    config: {
+        [key: string]: unknown;
+    };
+    culture: string;
+    versions: Version[];
+    endpoints: {
+        PRODUCTION: {
+            publishedDateTime: number | null;
+            publishedAppId: string;
+            publishedVersionId: string | null;
+            currentVersionId: string;
+            modifiedDateTime: number | null;
+            trainStatus: {
+                status: string;
+                message: string;
+                modelId: string;
+                date: number | null;
+            };
+            status: string;
+            endpointUrl?: string;
+            isStaging?: boolean;
+            region?: string;
+            endpointRegion?: string;
+        };
+    };
+    id: string;
+};
+export declare type KnowledgeModelOptionalFields = {
+    id: string;
+} & {
+    [K in keyof KnowledgeModel]?: KnowledgeModel[K];
+};
+export declare type PartialListResponse<T> = {
+    total: {
+        value: number;
+        relation: string;
+    };
+    items: T[];
+    last?: string;
+};
+export declare type KnowledgeModelCreateParams = {
+    name: string;
+    desc: string;
+    imageSrc: string;
+    config?: {
+        [key: string]: unknown;
+    };
+    culture: string;
+    extensions: string[];
+};
+export declare type LimitsResponse = string[];
+export declare type PrebuiltEntity = {
+    name: string;
+    description?: string;
+    examples?: string;
+};
+declare type EntityFeature = {
+    featureName: string;
+    isRequired: boolean;
+};
+declare type EntityChild = {
+    name: string;
+    features?: EntityFeature[];
+    children?: EntityChild[];
+    id: string;
+};
+export declare type Entity = {
+    name: string;
+    roles?: string[];
+    children?: EntityChild[];
+    features?: EntityFeature[];
+    kbId?: string;
+    prebuiltModelId?: string;
+    versionId?: string | null;
+    id: string;
+};
+export declare type Feature = {
+    kbId: string;
+    name: string;
+    mode: boolean;
+    words: string;
+    activated: boolean;
+    enabledForAllModels: boolean;
+    versionId: string | null;
+    id: string;
+};
+declare type UtteranceEntityChild = {
+    entity: string;
+    children: UtteranceEntityChild[];
+    startPos: number;
+    endPos: number;
+};
+export declare type UtteranceEntity = {
+    entity: string;
+    value: string;
+    role: string | null;
+    startPos: number;
+    endPos: number;
+    children: UtteranceEntityChild[];
+};
+export declare type Utterance = {
+    text: string;
+    intent: string;
+    entities: UtteranceEntity[];
+    entityPredictions: unknown[];
+    prebuiltModelId?: string;
+    dateCreated: number;
+    autoGenerated: boolean;
+    unrecognized: boolean;
+    intentCreated: number;
+    appCreated: number;
+    id: string;
+    versionId?: string | null;
+    application?: string;
+    kbId?: string;
+};
+declare type IntentFeature = EntityFeature;
+export declare type Intent = {
+    id: string;
+    name: string;
+    type: string;
+    kbId: string;
+    prebuiltModelId?: string;
+    application: string;
+    dateCreated: number;
+    postprocessFlows: string[];
+    customData?: {
+        [key: string]: unknown;
+    };
+    features: IntentFeature[];
+    versionId: string | null;
+};
+export declare type Application = {
+    luis_schema_version: string;
+    versionId: string | null;
+    luisId: string;
+    name: string;
+    desc: string;
+    culture: string;
+    endpoints: {
+        PRODUCTION: {
+            publishedDateTime: number | null;
+            publishedVersionId: number | null;
+            modifiedDateTime: number;
+            trainStatus: {
+                status: string;
+                message: string;
+                modelId: string;
+                date: number | null;
+            };
+            status: string;
+        };
+    };
+    composites: string[];
+    closedLists: string[];
+    patternAnyEntities: string[];
+    model_features: string[];
+    regex_features: string[];
+    patterns: string[];
+    settings: string[];
+    id: string;
+    dateCreated: number;
+    intents: Intent[];
+    utterances: Utterance[];
+};
+export declare type IntentLabelsResponse = {
+    [key: string]: {
+        utterances: number;
+        patterns: number;
+    };
+};
+export declare type PatternEntity = {
+    entity: string;
+    order: number;
+};
+export declare type Pattern = {
+    kbId: string;
+    appCreated: number;
+    pattern: string;
+    intent: string;
+    intentCreated: number;
+    entities: PatternEntity[];
+    application: string;
+    versionId: string | null;
+    dateCreated: number;
+    id: string;
+};
+declare type PrebuiltModelEntity = {
+    name: string;
+    children: PrebuiltModelEntity[];
+    type: string;
+};
+export declare type PrebuiltModel = {
+    id: string;
+    name: string;
+    description: string;
+    versionId: string;
+    dateCreated: number;
+    responses: string[];
+    entities: PrebuiltModelEntity[];
+    language: string;
+};
+declare type PrebuiltModelDetailsResponse = {
+    name: string;
+    id: string;
+};
+declare type PrebuiltModelDetailsEntity = {
+    name: string;
+    id: string;
+};
+export declare type PrebuiltModelDetails = {
+    responses: PrebuiltModelDetailsResponse[];
+    entities: PrebuiltModelDetailsEntity[];
+    application: string;
+};
+export declare type Pair = {
+    application: Application;
+    intent: Intent;
+    utterance?: Utterance;
+    pattern?: Pattern;
+};
+export declare type CreatePairsResponse = {
+    accepted: Utterance[];
+    failed: {
+        utterance: Utterance;
+        reason: string;
+    }[];
+};
+export declare type UpdatedPairsResponse = CreatePairsResponse;
+export declare type TrainStatusResponse = {
+    status: string;
+    message: string;
+    details: string;
+    priority?: number;
+    date: number;
+};
+export declare type TrainResponse = {
+    status: string;
+};
+export declare type PublishResponse = {
+    status: string;
+};
+export declare type ImportResponse = {
+    createdKb: KnowledgeModel;
+};
+export declare type CloneResponse = ImportResponse;
+declare type MeaningAnswer = {
+    answer: string;
+    answerId: string;
+    type: string;
+    score: number;
+    contextId: string;
+    context: string;
+};
+declare type MeaningPatternsMatch = {
+    answer: string;
+    answerId: string;
+    type: string;
+    score: number | null;
+    contextId: string;
+    context: string;
+    pattern: string;
+};
+declare type MeaningEntity = UtteranceEntity;
+export declare type MeaningResponse = {
+    result: {
+        question: string;
+        answer: string;
+        answerId: string;
+        type: string;
+        contextId: string;
+        context: string;
+        luisId: string;
+        topAnswers: MeaningAnswer[];
+        entities: MeaningEntity[];
+        patternsMatches: MeaningPatternsMatch[];
+    };
+    targetQuestion: string;
+    confidence: number;
+    tokenizedText: string[];
+};
+export {};

package/dist/types/utils/getEntityBody.d.ts

@@ -0,0 +1,6 @@
+declare function getEntityBody(type: string, data: {
+    [key: string]: unknown;
+}): {
+    [key: string]: unknown;
+};
+export default getEntityBody;

package/dist/types/utils/index.d.ts

@@ -0,0 +1 @@
+export { default as getEntityBody } from './getEntityBody';

package/package.json

@@ -0,0 +1,29 @@
+{
+  "version": "0.12.0",
+  "name": "@or-sdk/knowledge-models",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && concurrently \"npm run build:cjs\" \"npm run build:esm\" \"npm run build:types\"",
+    "build:watch": "concurrently -r --hide 1,2 \"npm run build:watch:cjs\" \"npm run build:watch:esm\" \"npm run build:watch:types\"",
+    "build:cjs": "tsc --project tsconfig.json",
+    "build:watch:cjs": "tsc --project tsconfig.json -w",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:watch:esm": "tsc --project tsconfig.esm.json -w",
+    "build:types": "tsc --project tsconfig.types.json",
+    "build:watch:types": "tsc --project tsconfig.types.json -w",
+    "clean": "rm -rf ./dist"
+  },
+  "devDependencies": {
+    "concurrently": "^6.4.0",
+    "typescript": "^4.4.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@or-sdk/base": "^0.12.0"
+  },
+  "gitHead": "c45d0715d7049529794b9fdc30e625c01238f508"
+}