Crate coqui_stt_sys

Structs

• CandidateTranscript
  @brief A single transcript computed by the model, including a confidence value and the metadata for its constituent tokens.
• Metadata
  @brief An array of CandidateTranscript objects computed by the model.
• ModelState
• StreamingState
• TokenMetadata
  @brief Stores text of an individual token, along with its timing information

Constants

• STT_Error_Codes_STT_ERR_FAIL_CLEAR_HOTWORD
• STT_Error_Codes_STT_ERR_FAIL_CREATE_MODEL
• STT_Error_Codes_STT_ERR_FAIL_CREATE_SESS
• STT_Error_Codes_STT_ERR_FAIL_CREATE_STREAM
• STT_Error_Codes_STT_ERR_FAIL_ERASE_HOTWORD
• STT_Error_Codes_STT_ERR_FAIL_INIT_MMAP
• STT_Error_Codes_STT_ERR_FAIL_INIT_SESS
• STT_Error_Codes_STT_ERR_FAIL_INSERT_HOTWORD
• STT_Error_Codes_STT_ERR_FAIL_INTERPRETER
• STT_Error_Codes_STT_ERR_FAIL_READ_PROTOBUF
• STT_Error_Codes_STT_ERR_FAIL_RUN_SESS
• STT_Error_Codes_STT_ERR_INVALID_ALPHABET
• STT_Error_Codes_STT_ERR_INVALID_SCORER
• STT_Error_Codes_STT_ERR_INVALID_SHAPE
• STT_Error_Codes_STT_ERR_MODEL_INCOMPATIBLE
• STT_Error_Codes_STT_ERR_NO_MODEL
• STT_Error_Codes_STT_ERR_OK
• STT_Error_Codes_STT_ERR_SCORER_INVALID_LM
• STT_Error_Codes_STT_ERR_SCORER_INVALID_TRIE
• STT_Error_Codes_STT_ERR_SCORER_NOT_ENABLED
• STT_Error_Codes_STT_ERR_SCORER_NO_TRIE
• STT_Error_Codes_STT_ERR_SCORER_UNREADABLE
• STT_Error_Codes_STT_ERR_SCORER_VERSION_MISMATCH

Functions

• STT_AddHotWord^⚠
  @brief Add a hot-word and its boost.
• STT_ClearHotWords^⚠
  @brief Removes all elements from the hot-words map.
• STT_CreateModel^⚠
  @brief An object providing an interface to a trained Coqui STT model.
• STT_CreateModelFromBuffer^⚠
  @brief An object providing an interface to a trained Coqui STT model, loaded from a buffer.
• STT_CreateStream^⚠
  @brief Create a new streaming inference state. The streaming state returned by this function can then be passed to {@link STT_FeedAudioContent()} and {@link STT_FinishStream()}.
• STT_DisableExternalScorer^⚠
  @brief Disable decoding using an external scorer.
• STT_EnableExternalScorer^⚠
  @brief Enable decoding using an external scorer.
• STT_EnableExternalScorerFromBuffer^⚠
  @brief Enable decoding using an external scorer loaded from a buffer.
• STT_EraseHotWord^⚠
  @brief Remove entry for a hot-word from the hot-words map.
• STT_ErrorCodeToErrorMessage^⚠
  @brief Returns a textual description corresponding to an error code. The string returned must be freed with @{link STT_FreeString()}.
• STT_FeedAudioContent^⚠
  @brief Feed audio samples to an ongoing streaming inference.
• STT_FinishStream^⚠
  @brief Compute the final decoding of an ongoing streaming inference and return the result. Signals the end of an ongoing streaming inference.
• STT_FinishStreamWithMetadata^⚠
  @brief Compute the final decoding of an ongoing streaming inference and return results including metadata. Signals the end of an ongoing streaming inference.
• STT_FreeMetadata^⚠
  @brief Free memory allocated for metadata information.
• STT_FreeModel^⚠
  @brief Frees associated resources and destroys model object.
• STT_FreeStream^⚠
  @brief Destroy a streaming state without decoding the computed logits. This can be used if you no longer need the result of an ongoing streaming inference and don’t want to perform a costly decode operation.
• STT_FreeString^⚠
  @brief Free a char* string returned by the Coqui STT API.
• STT_GetModelBeamWidth^⚠
  @brief Get beam width value used by the model. If {@link STT_SetModelBeamWidth} was not called before, will return the default value loaded from the model file.
• STT_GetModelSampleRate^⚠
  @brief Return the sample rate expected by a model.
• STT_IntermediateDecode^⚠
  @brief Compute the intermediate decoding of an ongoing streaming inference.
• STT_IntermediateDecodeFlushBuffers^⚠
  @brief EXPERIMENTAL: Compute the intermediate decoding of an ongoing streaming inference, flushing buffers first. This ensures that all audio that has been streamed so far is included in the result, but is more expensive than STT_IntermediateDecode() because buffers are processed through the acoustic model. Calling this function too often will also degrade transcription accuracy due to trashing of the LSTM hidden state vectors.
• STT_IntermediateDecodeWithMetadata^⚠
  @brief Compute the intermediate decoding of an ongoing streaming inference, return results including metadata.
• STT_IntermediateDecodeWithMetadataFlushBuffers^⚠
  @brief EXPERIMENTAL: Compute the intermediate decoding of an ongoing streaming inference, flushing buffers first. This ensures that all audio that has been streamed so far is included in the result, but is more expensive than STT_IntermediateDecodeWithMetadata() because buffers are processed through the acoustic model. Calling this function too often will also degrade transcription accuracy due to trashing of the LSTM hidden state vectors. Returns results including metadata.
• STT_SetModelBeamWidth^⚠
  @brief Set beam width value used by the model.
• STT_SetScorerAlphaBeta^⚠
  @brief Set hyperparameters alpha and beta of the external scorer.
• STT_SpeechToText^⚠
  @brief Use the Coqui STT model to convert speech to text.
• STT_SpeechToTextWithMetadata^⚠
  @brief Use the Coqui STT model to convert speech to text and output results including metadata.
• STT_Version^⚠
  @brief Returns the version of this library. The returned version is a semantic version (SemVer 2.0.0). The string returned must be freed with {@link STT_FreeString()}.

Type Aliases

• STT_Error_Codes