Class: PluginCatalog
Manages the global plugin catalog and annotations (not project-scoped).
Constructors
new PluginCatalog()
Internal
Parameters
| Parameter | Type |
|---|---|
ctx | ClientContext |
Returns
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/plugins.ts:23
Methods
get()
Get a plugin by slug
Parameters
| Parameter | Type | Description |
|---|---|---|
slug | string | Plugin slug (e.g. "profanity-filter") |
Returns
Promise<object>
Plugin details
| Name | Type | Description | Defined in |
|---|---|---|---|
capabilities | ("transcribe" | "analyze")[] | Description Capabilities of an audio plugin (empty for event plugins). A transcribe plugin can be selected as the project transcriber via PATCH /projects/{projectId}/settings/transcription. Example [] | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2535 |
category | | "moderation" | "analytics" | "automation" | "integration" | "transcription" | Description Category (UI grouping) | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2524 |
description? | string | Description Description | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2514 |
events | string[] | Description Event patterns Example [ "message.created" ] | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2542 |
icon? | string | Description Heroicons icon name Example heroicons_outline:shield-check | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2564 |
id | string | Description Plugin UUID | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2502 |
isActive | boolean | Description Whether plugin is available | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2566 |
kind | "event" | "audio" | Description How the plugin runs: event = reacts to domain events; audio = processes utterance audio in the bot (transcription providers, audio moderation) Example event @enum {string} | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2530 |
name | string | Description Display name Example Profanity Filter | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2512 |
outputAnnotationType? | "profanity" | "summary" | "action_items" | "sentiment" | Description Output annotation type | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2547 |
pricingUrl? | string | Description Pricing page URL for the tied Payment product, shown in the install cost-acceptance notice. Example https://odin.4players.io/pricing | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2559 |
productSlug? | string | Description Payment product slug this plugin activates (set = paid plugin). When present, installing/enabling the plugin activates this product and disabling/uninstalling deactivates it. Example amanda | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2554 |
settingsSchema? | object[] | Description Settings schema | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2549 |
slug | string | Description URL-friendly identifier Example profanity-filter | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2507 |
version | string | Description Semantic version Example 1.0.0 | odin-transcription-service/packages/cortex-typescript-sdk/src/types.ts:2519 |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/plugins.ts:40
getMessageAnnotationsBatch()
Batch retrieve annotations for multiple messages.
Only annotations of the caller's own tenant are returned. For a session of a
project you were invited to, use Session.watchMessageAnnotations(), which
goes through the project-scoped route.
Parameters
| Parameter | Type | Description |
|---|---|---|
messageIds | string[] | Array of message IDs |
Returns
Promise<Record<string, object[]>>
Annotations grouped by message ID
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/plugins.ts:72
getSessionAnnotations()
Get annotations for a session
Parameters
| Parameter | Type | Description |
|---|---|---|
sessionId | string | Session ID |
Returns
Promise<object[]>
Array of session annotations
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/plugins.ts:53
list()
List all available plugins in the catalog
Returns
Promise<object[]>
Array of plugins
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/plugins.ts:29