Referência de símbolos
Referência de símbolos
Pergunta: "qual símbolo exportado devo usar para conectar, observar e reprocessar?"
| Símbolo | Uso |
|---|---|
connectTranscription(input) | Resolve endpoint direto ou discovery, inicia candidatos em ordem e retorna a primeira sessão pronta. |
resolveTranscriptionConfig(input) | Resolve entrada em candidatos; não cria nem inicia sessão. |
createTranscriptionSession(provider, config) | Factory síncrona de baixo nível para uma sessão. |
TranscriptionSession | Contrato de start, stop, pause, resume, on, off. |
TranscriptionEventMap | Mapa tipado de ready, recognizing, recognized, reconexão, desconexão e error. |
TranscriptionError | Base pública com code e cause. |
TranscriptionEnvironmentError | Falha de browser/contexto seguro/microfone antes da sessão. |
TranscriptionSessionError | Falha de microfone ou transporte da sessão. |
TranscriptionConnectionError | Falha após esgotar candidatos; expõe attempts. |
isReprocessCapable(session) | Guarda estrutural para ReprocessCapable. |
ReprocessCapable | reprocessAudio, status e tempo remanescente após parar a sessão. |
TranscriptResult | Resultado batch: data.text, data.language, data.words. |
createDurableSessionJournal() | Cria jornal durável pelo subpath @sofya-sdk/transcription/journal. |
import {
createTranscriptionSession,
isReprocessCapable,
type TranscriptionSessionConfig,
} from '@sofya-sdk/transcription';
const config: TranscriptionSessionConfig = {
auth: { endpoint: '<wss-url>' },
languages: { transcription: 'pt-BR' },
};
const session = createTranscriptionSession('sofya_as_service', config);
await session.start();
if (isReprocessCapable(session)) console.log(session.getReprocessStatus().state);
await session.stop();Os símbolos desta página descrevem a versão 0.1.0. A URL pública versionada será
declarada na superfície do portal em trabalho separado; não há rota adicional declarada por
esta documentação de pacote.
Last updated on