Skip to content

Commit b8b0ffc

Browse files
authored
gladiaOptions for recognizer (#101)
1 parent e029fad commit b8b0ffc

File tree

1 file changed

+129
-0
lines changed

1 file changed

+129
-0
lines changed

fern/docs/pages/verbs/recognizer.mdx

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -799,6 +799,135 @@ subtitle: A **property** that can be used in verbs like [`gather`](./gather) and
799799

800800
</Accordion>
801801

802+
<Accordion title="gladiaOptions">
803+
<ParamField path="model" type="string" required={false}>
804+
The processing model to use.
805+
Default: `'solaria-1'`.
806+
</ParamField>
807+
808+
<ParamField path="endpointing" type="number" required={false}>
809+
Duration of silence (in seconds) that triggers utterance completion.
810+
Value must be between `0.01` and `10`.
811+
Default: `0.05`.
812+
</ParamField>
813+
814+
<ParamField path="maximum_duration_without_endpointing" type="number" required={false}>
815+
Maximum duration (in seconds) without endpointing detection.
816+
Value must be between `5` and `60`.
817+
Default: `5`.
818+
</ParamField>
819+
820+
<ParamField path="custom_metadata" type="object" required={false}>
821+
Attach custom metadata to the transcription session.
822+
</ParamField>
823+
824+
<ParamField path="language_config" type="object" required={false}>
825+
Language configuration for the transcription.
826+
</ParamField>
827+
828+
<ParamField path="language_config.languages" type="array" required={false}>
829+
Array of language codes to use for transcription.
830+
</ParamField>
831+
832+
<ParamField path="language_config.code_switching" type="boolean" required={false}>
833+
Enable automatic language switching within the audio stream.
834+
</ParamField>
835+
836+
<ParamField path="pre_processing" type="object" required={false}>
837+
Audio pre-processing configuration.
838+
</ParamField>
839+
840+
<ParamField path="pre_processing.audio_enhancer" type="boolean" required={false}>
841+
Enable audio enhancement processing.
842+
</ParamField>
843+
844+
<ParamField path="pre_processing.speech_threshold" type="number" required={false}>
845+
Speech detection threshold value.
846+
</ParamField>
847+
848+
<ParamField path="realtime_processing" type="object" required={false}>
849+
Real-time processing configuration.
850+
</ParamField>
851+
852+
<ParamField path="realtime_processing.custom_vocabulary" type="array" required={false}>
853+
Array of custom vocabulary terms to improve recognition accuracy.
854+
</ParamField>
855+
856+
<ParamField path="realtime_processing.custom_vocabulary_config" type="object" required={false}>
857+
Configuration for custom vocabulary behavior.
858+
</ParamField>
859+
860+
<ParamField path="realtime_processing.custom_spelling" type="array" required={false}>
861+
Array of custom spelling rules.
862+
</ParamField>
863+
864+
<ParamField path="realtime_processing.custom_spelling_config" type="object" required={false}>
865+
Configuration for custom spelling behavior.
866+
</ParamField>
867+
868+
<ParamField path="realtime_processing.translation" type="boolean" required={false}>
869+
Enable real-time translation.
870+
</ParamField>
871+
872+
<ParamField path="realtime_processing.translation_config" type="object" required={false}>
873+
Translation configuration including target languages.
874+
</ParamField>
875+
876+
<ParamField path="realtime_processing.named_entity_recognition" type="boolean" required={false}>
877+
Enable named entity recognition (NER).
878+
</ParamField>
879+
880+
<ParamField path="realtime_processing.sentiment_analysis" type="boolean" required={false}>
881+
Enable sentiment analysis on transcriptions.
882+
</ParamField>
883+
884+
<ParamField path="post_processing" type="object" required={false}>
885+
Post-processing configuration.
886+
</ParamField>
887+
888+
<ParamField path="post_processing.summarization" type="boolean" required={false}>
889+
Enable automatic summarization.
890+
</ParamField>
891+
892+
<ParamField path="post_processing.summarization_config" type="object" required={false}>
893+
Configuration for summarization behavior.
894+
</ParamField>
895+
896+
<ParamField path="post_processing.chapterization" type="boolean" required={false}>
897+
Enable automatic chapter detection.
898+
</ParamField>
899+
900+
<ParamField path="messages_config" type="object" required={false}>
901+
Control which event types are received during the session.
902+
</ParamField>
903+
904+
<ParamField path="messages_config.receive_pre_final" type="boolean" required={false}>
905+
Receive pre-final transcription events.
906+
</ParamField>
907+
908+
<ParamField path="messages_config.receive_final" type="boolean" required={false}>
909+
Receive final transcription events.
910+
</ParamField>
911+
912+
<ParamField path="messages_config.receive_speech_recognition" type="boolean" required={false}>
913+
Receive speech recognition events.
914+
</ParamField>
915+
916+
<ParamField path="callback" type="boolean" required={false}>
917+
Enable callback delivery for transcription events.
918+
Default: `false`.
919+
</ParamField>
920+
921+
<ParamField path="callback_config" type="object" required={false}>
922+
Callback configuration when callback is enabled.
923+
</ParamField>
924+
925+
<ParamField path="callback_config.url" type="string" required={false}>
926+
URL to receive callback events.
927+
</ParamField>
928+
929+
</Accordion>
930+
802931
<Accordion title="speechmaticsOptions">
803932
<ParamField path="sm_audioEventsConfig" type="object" required={false}>
804933
Audio events to report.

0 commit comments

Comments
 (0)