Class Transcript

Hierarchy

Transcript

Index

Properties

Constructors

constructor

Methods

Properties

Private io

io: Io

rabbit

rabbit: <internal>.Rabbit

redis

redis: <internal>.Redis

Constructors

constructor

new Transcript(io: Io): Transcript

- Defined in packages/io-celio-transcript/src/index.ts:22
Parameters
- io: Io
Returns Transcript

Methods

onFinal

onFinal(handler: CallbackHandler): void

- Defined in packages/io-celio-transcript/src/index.ts:37
Subscribe only to the final transcriptions.

Parameters
- handler: CallbackHandler
  
  Function to respond the transcription results.
Returns void

onInterim

onInterim(handler: CallbackHandler): void

- Defined in packages/io-celio-transcript/src/index.ts:47
Subscribe only to the interim transcriptions before a sentence is finalized.

Parameters
- handler: CallbackHandler
  
  Function to respond the transcription results.
Returns void

onAll

onAll(handler: CallbackHandler): void

- Defined in packages/io-celio-transcript/src/index.ts:57
Subscribe to all transcriptions.

Parameters
- handler: CallbackHandler
  
  Function to respond the transcription results.
Returns void

switchModel

switchModel(model: string): void

- Defined in packages/io-celio-transcript/src/index.ts:67
Request all transcript workers to switch to a model.

Parameters
- model: string
  
  The name of the model to switch to.
Returns void

tagChannel

tagChannel(workerID: string, channelIndex: number, speakerName: string): Promise<<internal>.RabbitMessage<unknown>>

- Defined in packages/io-celio-transcript/src/index.ts:82
Request a transcript worker to tag a channel with a speaker name

Parameters
- workerID: string
  
  The transcript worker's UUID. Available in transcript messages' workerID field.
- channelIndex: number
  
  The channel index number. Available in transcript messages' channelIndex field.
- speakerName: string
  
  The speaker name to tag.
Returns Promise<<internal>.RabbitMessage<unknown>>
A promise that resolves to {content: Buffer('done')}.

addKeywords

addKeywords(words: string[]): void

- Defined in packages/io-celio-transcript/src/index.ts:97
Add keywords to all transcript worker

Parameters
- words: string[]
  
  An array of keywords
Returns void

stopPublishing

stopPublishing(): void

- Defined in packages/io-celio-transcript/src/index.ts:106
Request all transcript workers to stop publishing. Useful for entering a privacy mode.

Returns void

publish

publish(micType: string, isFinal: boolean, msg: <internal>.Record<string, unknown>): void

- Defined in packages/io-celio-transcript/src/index.ts:120
Publish transcript result on [near|far|beamform].[final|interim].transcript

Parameters
- micType: string
  
  The microphone type: near, far, beamform. Far-range mics are disabled when the agent speaker is playing audio. Beamform mics are disabled whenever some other types of mics are functioning.
- isFinal: boolean
  
  Indicates whether the result is final.
- msg: <internal>.Record<string, unknown>
  
  The transcript to publish.
Returns void

Generated using TypeDoc