@or-sdk/knowledge-models 0.25.9-beta.4275.0 → 0.26.0

package/CHANGELOG.md

@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.26.0](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/knowledge-models@0.25.8...@or-sdk/knowledge-models@0.26.0) (2026-08-05)
+
+
+### Features
+
+* **packages:** add package descriptions and published files metadata ([801f823](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/commit/801f823034717ef8b961405a73d51ebc2ec07649))
+
+
+
 ## [0.25.8](https://gitlab.internal.onereach.io/onereach/platform/or-sdk-next/compare/@or-sdk/knowledge-models@0.25.4...@or-sdk/knowledge-models@0.25.8) (2026-08-04)
 
 **Note:** Version bump only for package @or-sdk/knowledge-models

package/README.md

@@ -64,3 +64,61 @@ const knowledgeModels = new KnowledgeModels({
 ## More detail
 
 Full signatures and exported types are available in `src/` and `dist/types/`.
+
+
+## Additional API reference
+
+Methods below were missing from the package guide. Signatures and return types are taken directly from the exported source API.
+
+### `KnowledgeModels`
+
+| Method | Returns | Purpose |
+|---|---|---|
+| `listIntentsLabels({ appId, kbId }: { appId: string; kbId: string; })` | `Promise<IntentLabelsResponse>` | List intents labels |
+| `listUtterances({ kbId, limit, ...query }: { kbId: string; limit?: number; query?: { [key: string]: unknown; }; })` | `Promise<List<Utterance>>` | List utterances |
+| `listPatterns({ kbId, limit, ...query }: { kbId: string; limit?: number; query?: { [key: string]: unknown; }; })` | `Promise<List<Pattern>>` | List patterns |
+| `listPrebuiltModels({ limit, ...query }: { limit?: number; query?: { [key: string]: unknown; }; } = {})` | `Promise<List<PrebuiltModel>>` | List prebuilt models |
+| `removePrebuiltModelFromKM({ prebuiltModelId, kbId, }: { prebuiltModelId: string; kbId: string; })` | `Promise<void>` | Remove prebuilt model from knowledge model |
+| `addPrebuiltModelToKM({ kbId, prebuiltModelId, appId, appName, shouldCreateNewApplication, responses, entities, }: { kbId: string; prebuiltModelId: string; appId: string; appName: string; shouldCreateNewApplication: boolean; responses: string[]; entities: string[]; })` | `Promise<Application>` | Add prebuilt model to knowledge model |
+| `getPrebuiltModelDetails({ kbId, prebuiltModelId, }: { kbId: string; prebuiltModelId: string; })` | `Promise<PrebuiltModelDetails>` | Get prebuilt models details |
+| `createApplication({ kbId, name, desc, culture, model_features, }: { kbId: string; name: string; desc: string; culture: string; model_features: string[]; })` | `Promise<Application>` | Create application |
+| `createIntent({ name, type, kbId, appId, postprocessFlows, customData, features, }: { name: string; type: string; kbId: string; appId: string; postprocessFlows: string[]; customData?: { [key: string]: unknown; }; features: string[]; })` | `Promise<Intent>` | Create intent |
+| `createUtterance({ appId, kbId, autoGenerated, text, intent, entities, }: { appId: string; kbId: string; autoGenerated?: boolean; text: string; intent: string; entities: UtteranceEntity[]; })` | `Promise<Utterance>` | Create utterance |
+| `createPattern({ appId, kbId, pattern, intent, entities, }: { appId: string; kbId: string; pattern: string; intent: string; entities: PatternEntity[]; })` | `Promise<Pattern>` | Create pattern |
+| `createPair({ kbId, applicationName, intentName, intentType, utteranceText, }: { kbId: string; applicationName: string; intentName: string; intentType: string; utteranceText: string; })` | `Promise<Pair>` | Create pair |
+| `batchCreatePairs({ kbId, utterances, }: { kbId: string; utterances: { text: string; intent: string; intentType: string; application: string; }[]; })` | `Promise<CreatePairsResponse>` | Batch create pairs |
+| `batchCreatePairsFile({ kbId, fileUrl, }: { kbId: string; fileUrl: string; })` | `Promise<CreatePairsResponse>` | Batch create pairs from file |
+| `createPatternPair({ kbId, applicationName, intentName, intentType, patternText, patternEntities, }: { kbId: string; applicationName: string; intentName: string; intentType: string; patternText: string; patternEntities: PatternEntity[]; })` | `Promise<Pair>` | Create pattern pair |
+| `createPairsCsv({ kbId, fileUrl, applicationName, delimiter, }: { kbId: string; fileUrl: string; applicationName: string; delimiter: string; })` | `Promise<CreatePairsResponse>` | Create pairs from csv |
+| `createEntity({ type, kbId, name, roles, ...rest }: { type: string; kbId: string; name: string; roles: unknown[]; rest?: { [key: string]: unknown; }; })` | `Promise<Entity>` | Create entity |
+| `createFeature({ kbId, name, mode, words, enabledForAllModels, }: { kbId: string; name: string; mode: boolean; words: string[]; enabledForAllModels: boolean; })` | `Promise<Feature>` | Create feature |
+| `updateApplication({ kbId, id, name, desc, model_features, }: { kbId: string; id: string; name?: string; desc?: string; model_features?: string[]; })` | `Promise<Application>` | Update application |
+| `updateIntent({ name, type, id, appId, kbId, postprocessFlows, customData, features, }: { name?: string; type?: string; id: string; appId: string; kbId: string; postprocessFlows?: string[]; customData?: { [key: string]: unknown; }; features?: string[]; })` | `Promise<Intent>` | Update intent |
+| `updateUtterance({ appId, kbId, utterance, }: { appId: string; kbId: string; utterance: Utterance; })` | `Promise<Utterance>` | Update utterance |
+| `updatePattern({ appId, kbId, pattern, }: { appId: string; kbId: string; pattern: Pattern; })` | `Promise<Pattern>` | Update pattern |
+| `updatePair({ kbId, applicationName, intentName, intentType, utterance, }: { kbId: string; applicationName: string; intentName: string; intentType: string; utterance: Utterance; })` | `Promise<void>` | Update pair |
+| `batchUpdatePairs({ kbId, utterances, }: { kbId: string; utterances: Utterance[]; })` | `Promise<UpdatedPairsResponse>` | Batch update pairs |
+| `updateEntity({ type, id, kbId, name, roles, ...rest }: { type: string; id: string; kbId: string; name?: string; roles?: string[]; rest?: { [key: string]: unknown; }; })` | `Promise<Entity>` | Update entity |
+| `updateFeature({ kbId, id, name, mode, words, enabledForAllModels, activated = true, }: { kbId: string; id: string; name: string; mode: boolean; words: string[]; enabledForAllModels: boolean; activated: boolean; })` | `Promise<Feature>` | Update feature |
+| `updatePrebuiltEntities({ kbId, id, entity, }: { kbId: string; id: string; entity: { name: string; roles: string[]; }; })` | `Promise<Entity>` | Update prebuilt entities |
+| `deleteKnowledgeBase({ id }: { id: string; })` | `Promise<void>` | Delete knowledge base |
+| `deleteApplication({ kbId, appId }: { kbId: string; appId: string; })` | `Promise<void>` | Delete application |
+| `deleteIntent({ id, appId, kbId }: { id: string; appId: string; kbId: string; })` | `Promise<void>` | Delete intent |
+| `deleteUtterance({ id, kbId }: { id: string; kbId: string; })` | `Promise<void>` | Delete utterance |
+| `batchDeleteUtterances({ ids, kbId }: { ids: string[]; kbId: string; })` | `Promise<void>` | Batch delete utterances |
+| `deletePattern({ id, kbId }: { id: string; kbId: string; })` | `Promise<void>` | Delete pattern |
+| `deleteEntity({ type, id, kbId }: { type: string; id: string; kbId: string; })` | `Promise<void>` | Delete entity |
+| `deleteFeature({ id, kbId }: { id: string; kbId: string; })` | `Promise<void>` | Delete feature |
+| `getTrainStatus({ kbId, versionId = null, }: { kbId: string; versionId: string \| null; })` | `Promise<TrainStatusResponse>` | Get training status |
+| `train({ kbId, flowId, phraseId, sessionId, autoPublish, }: { kbId: string; flowId?: string; phraseId?: string; sessionId?: string; autoPublish: boolean; })` | `Promise<TrainResponse>` | Start training |
+| `trainForTest({ kbId, flowId, phraseId, sessionId, }: { kbId: string; flowId?: string; phraseId?: string; sessionId?: string; })` | `Promise<TrainResponse>` | Start training for test |
+| `publish({ kbId, versionId = null, }: { kbId: string; versionId?: string \| null; })` | `Promise<PublishResponse>` | Publish knowledge model |
+| `recover({ kbId, versionId }: { kbId: string; versionId: string; })` | `Promise<void>` | Recover knowledge model version |
+| `deleteVersion({ kbId, versionId }: { kbId: string; versionId: string; })` | `Promise<void>` | Delete knowledge model version |
+| `clone({ kbId, newName }: { kbId: string; newName: string; })` | `Promise<CloneResponse>` | Clone knowledge model |
+| `export({ kbId, isPublic }: { kbId: string; isPublic?: boolean; })` | `Promise<string>` | Export knowledge model |
+| `import({ fileUrl, knowledgeBase, }: { fileUrl: string; knowledgeBase: KnowledgeModelCreateParams; })` | `Promise<ImportResponse>` | Import knowledge model |
+| `importJson(data: string)` | `Promise<ImportResponse>` | Import knowledge model from JSON |
+| `importCsv({ fileUrl, knowledgeBase, applicationName, delimiter, }: { fileUrl: string; knowledgeBase: KnowledgeModelCreateParams; applicationName?: string; delimiter?: string; })` | `Promise<ImportResponse>` | Import knowledge model from csv |
+| `meaning(data: { q: string; appId: string; kbId: string; suggestedConfidenceRange?: [number, number]; unrecognizedConfidenceRange?: [number, number]; allowSuggested: boolean; allowUnrecognized: boolean; spellCheckEnabled?: boolean; phraseId: string; sessionId: string; flowId: string; })` | `Promise<MeaningResponse>` | meaning |
+| `testMeaning({ q, appId, kbId }: { q: string; appId: string; kbId: string; })` | `Promise<MeaningResponse>` | Test meaning |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@or-sdk/knowledge-models",
-  "version": "0.25.9-beta.4275.0",
+  "version": "0.26.0",
   "description": "OneReach SDK client for Knowledge Models",
   "license": "Apache-2.0",
   "main": "dist/cjs/index.js",
@@ -33,5 +33,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "gitHead": "6dc62c7c3a3a05b2dfc5a1c7c9bfd4c5e8eb0b99"
 }