@proteos/sdk 0.20.0 → 0.20.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proteos/sdk",
-  "version": "0.20.0",
+  "version": "0.20.1",
   "license": "Apache-2.0",
   "description": "TypeScript SDK for the Proteos platform",
   "repository": {
@@ -66,8 +66,8 @@
     "tsup": "^8.3.0",
     "typescript": "^5.7.0",
     "vitest": "^3.0.0",
-    "@proteos/tsconfig": "0.0.0",
-    "@proteos/biome-config": "0.0.0"
+    "@proteos/biome-config": "0.0.0",
+    "@proteos/tsconfig": "0.0.0"
   },
   "scripts": {
     "build": "tsup",

package/src/auth/platform-entities.ts

@@ -62,6 +62,7 @@ export const PLATFORM_ENTITIES: readonly PlatformEntity[] = [
   { slug: 'messages', name: 'Messages' },
   { slug: 'agent-listeners', name: 'Agent Listeners' },
   { slug: 'transcriptions', name: 'Transcriptions' },
+  { slug: 'glossary-terms', name: 'Glossary Terms' },
   // Connectors (connector-service). `connections` above is shared; this is the
   // manifest catalog.
   { slug: 'connectors', name: 'Connectors' },

package/src/conversation/index.ts

@@ -10,10 +10,13 @@ import type {
   Conversation,
   CreateAgentListenerRequest,
   CreateConnectionRequest,
+  CreateGlossaryTermRequest,
   DispatchMeetingBotRequest,
+  GlossaryTerm,
   InstallConnectionResponse,
   ListAgentListenersQuery,
   ListConnectionsQuery,
+  ListGlossaryTermsQuery,
   ListConversationsQuery,
   ListMessagesQuery,
   ListParticipantsQuery,
@@ -28,6 +31,7 @@ import type {
   UnreadCounts,
   UpdateAgentListenerRequest,
   UpdateConnectionRequest,
+  UpdateGlossaryTermRequest,
 } from './types.js'
 
 const CONVERSATION_BASE_PATH = '/conversations/v1'
@@ -47,6 +51,8 @@ export class ConversationClient {
   readonly conversations: ConversationService
   readonly messages: MessageService
   readonly agentListeners: AgentListenerService
+  /** Per-org glossary: custom vocabulary that boosts transcription accuracy. */
+  readonly glossaryTerms: GlossaryTermService
   readonly transcriptions: TranscriptionService
   /** Meeting bots (Ava): dispatch into a meeting URL, remove from a meeting. */
   readonly meetings: MeetingService
@@ -58,6 +64,7 @@ export class ConversationClient {
     this.conversations = new ConversationServiceImpl(client)
     this.messages = new MessageServiceImpl(client)
     this.agentListeners = new AgentListenerServiceImpl(client)
+    this.glossaryTerms = new GlossaryTermServiceImpl(client)
     this.transcriptions = new TranscriptionServiceImpl(client)
     this.meetings = new MeetingServiceImpl(client)
     this.voice = new VoiceServiceImpl(client)
@@ -277,6 +284,44 @@ class AgentListenerServiceImpl implements AgentListenerService {
   }
 }
 
+/**
+ * Per-org glossary: custom-vocabulary terms that boost transcription accuracy.
+ * A term feeds the transcription provider's keyterm prompting; `priority` ranks
+ * a term (prioritized terms are injected first, then unprioritized), which
+ * decides the top 100 sent when an org stores more than the provider's cap.
+ */
+export interface GlossaryTermService {
+  list(query?: ListGlossaryTermsQuery): Promise<ListResponse<GlossaryTerm>>
+  get(id: string): Promise<GlossaryTerm>
+  create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm>
+  update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm>
+  delete(id: string): Promise<void>
+}
+
+class GlossaryTermServiceImpl implements GlossaryTermService {
+  constructor(private readonly client: ProteosClient) {}
+
+  list(query: ListGlossaryTermsQuery = {}): Promise<ListResponse<GlossaryTerm>> {
+    return this.client.requestWithQuery('GET', `${CONVERSATION_BASE_PATH}/glossary-terms`, query)
+  }
+
+  get(id: string): Promise<GlossaryTerm> {
+    return this.client.request('GET', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`)
+  }
+
+  create(request: CreateGlossaryTermRequest): Promise<GlossaryTerm> {
+    return this.client.request('POST', `${CONVERSATION_BASE_PATH}/glossary-terms`, request)
+  }
+
+  update(id: string, request: UpdateGlossaryTermRequest): Promise<GlossaryTerm> {
+    return this.client.request('PATCH', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`, request)
+  }
+
+  async delete(id: string): Promise<void> {
+    await this.client.request('DELETE', `${CONVERSATION_BASE_PATH}/glossary-terms/${encodeURIComponent(id)}`)
+  }
+}
+
 /** Batch transcription of stored audio files + materialization. */
 export interface TranscriptionService {
   /**

package/src/conversation/types.ts

@@ -439,6 +439,45 @@ export interface UpdateAgentListenerRequest {
   priority?: number
 }
 
+/**
+ * A per-org glossary term: custom vocabulary that improves transcription
+ * accuracy. `term` is the boost phrase injected into the provider's keyterm
+ * prompting; `definition` is human/agent documentation only. `priority` ranks a
+ * term for injection (prioritized terms outrank unprioritized; lower number
+ * first) and decides which terms win when the org exceeds the provider's 100-term
+ * per-request cap.
+ */
+export interface GlossaryTerm {
+  id: string
+  org_id: string
+  term: string
+  definition?: string
+  priority?: number
+  created_at: string
+  created_by: UserRef
+  updated_at: string
+  updated_by: UserRef
+}
+
+export interface CreateGlossaryTermRequest {
+  term: string
+  definition?: string
+  priority?: number
+}
+
+export interface UpdateGlossaryTermRequest {
+  term?: string
+  definition?: string
+  priority?: number
+  /** Removes the term's priority (unprioritizes it) regardless of `priority`. */
+  is_priority_cleared?: boolean
+}
+
+export interface ListGlossaryTermsQuery extends PaginationQuery {
+  /** Case-insensitive substring match on the term text. */
+  search?: string
+}
+
 export interface PaginationQuery {
   page?: number
   page_size?: number

package/src/index.ts

@@ -183,10 +183,14 @@ export type {
   ConversationStatus,
   CreateAgentListenerRequest,
   CreateConnectionRequest,
+  CreateGlossaryTermRequest,
   DispatchMeetingBotRequest,
+  GlossaryTerm,
+  GlossaryTermService,
   InstallConnectionResponse,
   ListAgentListenersQuery,
   ListConnectionsQuery,
+  ListGlossaryTermsQuery,
   ListConversationsQuery,
   ListMessagesQuery,
   ListParticipantsQuery,
@@ -218,6 +222,7 @@ export type {
   UnreadCounts,
   UpdateAgentListenerRequest,
   UpdateConnectionRequest,
+  UpdateGlossaryTermRequest,
   VoiceService,
   VoiceTranscriptionStream,
 } from './conversation/index.js'