@or-sdk/knowledge-models 0.12.0

package/src/constants.ts

@@ -0,0 +1 @@
+export const SERVICE_KEY = 'nlu-api';

package/src/index.ts

@@ -0,0 +1,2 @@
+export { KnowledgeModels } from './KnowledgeModels';
+export * from './types';

package/src/types.ts

@@ -0,0 +1,347 @@
+import { Token } from '@or-sdk/base';
+
+export type KnowledgeModelsConfig = {
+  /**
+   * token
+   */
+  token: Token;
+  /**
+   * Url of OneReach service discovery api
+   */
+  discoveryUrl: string;
+};
+
+export type Version = {
+  versionId: string;
+  trainStatus: {
+    status: string;
+    message: string;
+    modelId: string;
+    date: number;
+  };
+  prebuiltModelIds?: string[];
+};
+
+export 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 type KnowledgeModelOptionalFields = { id: string; } & {
+  [K in keyof KnowledgeModel]?: KnowledgeModel[K];
+};
+
+export type PartialListResponse<T> = {
+  total: {
+    value: number;
+    relation: string;
+  };
+  items: T[];
+  last?: string;
+};
+
+export type KnowledgeModelCreateParams = {
+  name: string;
+  desc: string;
+  imageSrc: string;
+  config?: {
+    [key: string]: unknown;
+  };
+  culture: string;
+  extensions: string[];
+};
+
+export type LimitsResponse = string[];
+
+export type PrebuiltEntity = {
+  name: string;
+  description?: string;
+  examples?: string;
+};
+
+type EntityFeature = {
+  featureName: string;
+  isRequired: boolean;
+};
+
+type EntityChild = {
+  name: string;
+  features?: EntityFeature[];
+  children?: EntityChild[];
+  id: string;
+};
+
+export type Entity = {
+  name: string;
+  roles?: string[];
+  children?: EntityChild[];
+  features?: EntityFeature[];
+  kbId?: string;
+  prebuiltModelId?: string;
+  versionId?: string | null;
+  id: string;
+};
+
+export type Feature = {
+  kbId: string;
+  name: string;
+  mode: boolean;
+  words: string;
+  activated: boolean;
+  enabledForAllModels: boolean;
+  versionId: string | null;
+  id: string;
+};
+
+type UtteranceEntityChild = {
+  entity: string;
+  children: UtteranceEntityChild[];
+  startPos: number;
+  endPos: number;
+};
+
+export type UtteranceEntity = {
+  entity: string;
+  value: string;
+  role: string | null;
+  startPos: number;
+  endPos: number;
+  children: UtteranceEntityChild[];
+};
+
+export 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;
+};
+
+type IntentFeature = EntityFeature;
+
+export 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 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 type IntentLabelsResponse = {
+  [key: string]: {
+    utterances: number;
+    patterns: number;
+  };
+};
+
+export type PatternEntity = {
+  entity: string;
+  order: number;
+};
+
+export type Pattern = {
+  kbId: string;
+  appCreated: number;
+  pattern: string;
+  intent: string;
+  intentCreated: number;
+  entities: PatternEntity[];
+  application: string;
+  versionId: string | null;
+  dateCreated: number;
+  id: string;
+};
+
+type PrebuiltModelEntity = {
+  name: string;
+  children: PrebuiltModelEntity[];
+  type: string;
+};
+
+export type PrebuiltModel = {
+  id: string;
+  name: string;
+  description: string;
+  versionId: string;
+  dateCreated: number;
+  responses: string[];
+  entities: PrebuiltModelEntity[];
+  language: string;
+};
+
+type PrebuiltModelDetailsResponse = {
+  name: string;
+  id: string;
+};
+
+type PrebuiltModelDetailsEntity = {
+  name: string;
+  id: string;
+};
+
+export type PrebuiltModelDetails = {
+  responses: PrebuiltModelDetailsResponse[];
+  entities: PrebuiltModelDetailsEntity[];
+  application: string;
+};
+
+export type Pair = {
+  application: Application;
+  intent: Intent;
+  utterance?: Utterance;
+  pattern?: Pattern;
+};
+
+export type CreatePairsResponse = {
+  accepted: Utterance[];
+  failed: {
+    utterance: Utterance;
+    reason: string;
+  }[];
+};
+
+export type UpdatedPairsResponse = CreatePairsResponse;
+
+export type TrainStatusResponse = {
+  status: string;
+  message: string;
+  details: string;
+  priority?: number;
+  date: number;
+};
+
+export type TrainResponse = {
+  status: string;
+};
+
+export type PublishResponse = {
+  status: string;
+};
+
+export type ImportResponse = {
+  createdKb: KnowledgeModel;
+};
+
+export type CloneResponse = ImportResponse;
+
+type MeaningAnswer = {
+  answer: string;
+  answerId: string;
+  type: string;
+  score: number;
+  contextId: string;
+  context: string;
+};
+
+type MeaningPatternsMatch = {
+  answer: string;
+  answerId: string;
+  type: string;
+  score: number | null;
+  contextId: string;
+  context: string;
+  pattern: string;
+};
+
+type MeaningEntity = UtteranceEntity;
+
+export 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[];
+};

package/src/utils/getEntityBody.ts

@@ -0,0 +1,37 @@
+function getEntityBody(type: string, data: { [key: string]: unknown; }): { [key: string]: unknown; } {
+  const base = {
+    name: data.name,
+    roles: data.roles,
+  };
+  switch (type) {
+    case 'simple':
+      return {
+        ...base,
+        features: data.features,
+        children: data.children,
+      };
+    case 'regex':
+      return {
+        ...base,
+        regexPattern: data.regexPattern,
+      };
+    case 'prebuilt':
+      return base;
+    case 'postprocess':
+      return {
+        name: data.name,
+        processFlow: data.processFlow,
+      };
+    case 'list':
+      return {
+        ...base,
+        subLists: data.subLists,
+      };
+    case 'patternany':
+      return base;
+    default:
+      throw new Error(`Unknown entity type ${type}`);
+  }
+}
+
+export default getEntityBody;

package/src/utils/index.ts

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

package/tsconfig.esm.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "module": "ES6",
+    "target": "es6",
+    "outDir": "./dist/esm/",
+    "rootDir": "./src"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs/",
+    "rootDir": "./src"
+  }
+}

package/tsconfig.types.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/types/",
+    "rootDir": "./src",
+    "declaration": true,
+    "emitDeclarationOnly": true
+  }
+}