> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ai-coustics.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Python API reference

> Complete public API surface for aic-sdk 3.3.0: models, enhancement, VAD, analysis and errors.

**Package:** `aic-sdk==3.3.0`. **Core SDK:** `0.25.0`. Import the package as `aic_sdk`. The [Python guide](/reference/sdk/language-bindings/python) contains installation and the runnable audio example.

Source: [Python wrapper 3.3.0 at `6cd7b9e`](https://github.com/ai-coustics/aic-sdk-py/tree/6cd7b9e0a82410e6b0db63efea1d0b0ac248e61e). Where released type stubs differ from runtime behavior, the entries note the correction.

## Domains

| Domain | Use it to |
| - | - |
| [Models and configuration](/reference/sdk/api/python/models-and-config) | Load models, choose audio configuration and configure OpenTelemetry |
| [Enhancement](/reference/sdk/api/python/enhancement) | Process audio synchronously or asynchronously and control stream state |
| [Voice activity detection](/reference/sdk/api/python/vad) | Run dedicated VAD models, or detect speech from an enhancement processor, and read speech decisions |
| [Audio analysis](/reference/sdk/api/python/analysis) | Buffer live audio or analyze complete buffers with Tyto |
| [Errors](/reference/sdk/api/python/errors) | Identify failures and implement recovery |

## Shared conventions

Use `import aic_sdk as aic` and `import numpy as np` in application code. Reference signatures abbreviate `numpy.typing` as `npt` and standard-library `typing` as `typing`. Reference fragments assume the model, credential and initialized object from the linked guide. They are not separate end-to-end tutorials.

Audio is one-dimensional mono NumPy `float32`, at the configured sample rate. The enhancement wrapper copies its input and returns a new array; VAD and collection leave input unchanged. Each processing object owns stream state. Await blocks in order on async instances and use separate instances for independent streams. Do not share a mutable input with concurrent native work.

Configuration objects are copied at initialization or construction; later field edits do not reconfigure existing native objects. Python owns the native handles and releases them with the corresponding objects. A memory-mapped model file must not be modified or deleted while the model or any dependent processing object remains alive. After termination, create a new processing object to start another session.

All documented classes and functions are available in this released package; there are no Python feature flags for this surface. `set_sdk_id` is a runtime integration hook intentionally excluded from the supported public API. Runtime shutdown and automatically inherited Python object machinery are implementation details; the explicitly implemented diagnostic representations are listed below. Native-only raw-buffer model loading is not exposed in Python.

## Symbol index

Each symbol links directly to its constructor, member, field or function. Property setters share the getter's entry and are labeled read/write in the domain page. Symbols are sorted alphabetically.

| Symbol | Kind |
| - | - |
| [`AnalysisResult`](/reference/sdk/api/python/analysis#analysisresult) | class |
| [`AnalysisResult.__repr__`](/reference/sdk/api/python/analysis#analysisresult-__repr__) | method |
| [`AnalysisResult.codec_degradation`](/reference/sdk/api/python/analysis#analysisresult-codec_degradation) | property |
| [`AnalysisResult.interfering_speech`](/reference/sdk/api/python/analysis#analysisresult-interfering_speech) | property |
| [`AnalysisResult.noise`](/reference/sdk/api/python/analysis#analysisresult-noise) | property |
| [`AnalysisResult.packet_loss`](/reference/sdk/api/python/analysis#analysisresult-packet_loss) | property |
| [`AnalysisResult.risk_score`](/reference/sdk/api/python/analysis#analysisresult-risk_score) | property |
| [`AnalysisResult.speaker_loudness`](/reference/sdk/api/python/analysis#analysisresult-speaker_loudness) | property |
| [`AnalysisResult.speaker_reverb`](/reference/sdk/api/python/analysis#analysisresult-speaker_reverb) | property |
| [`Analyzer`](/reference/sdk/api/python/analysis#analyzer) | class |
| [`Analyzer.analyze_buffered`](/reference/sdk/api/python/analysis#analyzer-analyze_buffered) | method |
| [`Analyzer.reset`](/reference/sdk/api/python/analysis#analyzer-reset) | method |
| [`Analyzer.terminate_session`](/reference/sdk/api/python/analysis#analyzer-terminate_session) | method |
| [`Analyzer.update_bearer_token`](/reference/sdk/api/python/analysis#analyzer-update_bearer_token) | method |
| [`analyzer_pair`](/reference/sdk/api/python/analysis#analyzer_pair) | function |
| [`AudioConfigMismatchError`](/reference/sdk/api/python/errors#audioconfigmismatcherror) | class |
| [`AudioConfigMismatchError()`](/reference/sdk/api/python/errors#audioconfigmismatcherror-constructor) | constructor |
| [`AudioConfigMismatchError.message`](/reference/sdk/api/python/errors#audioconfigmismatcherror-message) | property |
| [`AudioConfigUnsupportedError`](/reference/sdk/api/python/errors#audioconfigunsupportederror) | class |
| [`AudioConfigUnsupportedError()`](/reference/sdk/api/python/errors#audioconfigunsupportederror-constructor) | constructor |
| [`AudioConfigUnsupportedError.message`](/reference/sdk/api/python/errors#audioconfigunsupportederror-message) | property |
| [`Collector`](/reference/sdk/api/python/analysis#collector) | class |
| [`Collector.buffer`](/reference/sdk/api/python/analysis#collector-buffer) | method |
| [`Collector.initialize`](/reference/sdk/api/python/analysis#collector-initialize) | method |
| [`EnergyVadContext`](/reference/sdk/api/python/vad#energyvadcontext) | class |
| [`EnergyVadContext.get_parameter`](/reference/sdk/api/python/vad#energyvadcontext-get_parameter) | method |
| [`EnergyVadContext.get_prediction_delay`](/reference/sdk/api/python/vad#energyvadcontext-get_prediction_delay) | method |
| [`EnergyVadContext.is_speech_detected`](/reference/sdk/api/python/vad#energyvadcontext-is_speech_detected) | method |
| [`EnergyVadContext.reset`](/reference/sdk/api/python/vad#energyvadcontext-reset) | method |
| [`EnergyVadContext.set_parameter`](/reference/sdk/api/python/vad#energyvadcontext-set_parameter) | method |
| [`FileAnalyzer`](/reference/sdk/api/python/analysis#fileanalyzer) | class |
| [`FileAnalyzer()`](/reference/sdk/api/python/analysis#fileanalyzer-constructor) | constructor |
| [`FileAnalyzer.analyze`](/reference/sdk/api/python/analysis#fileanalyzer-analyze) | method |
| [`FilePathInvalidError`](/reference/sdk/api/python/errors#filepathinvaliderror) | class |
| [`FilePathInvalidError()`](/reference/sdk/api/python/errors#filepathinvaliderror-constructor) | constructor |
| [`FilePathInvalidError.message`](/reference/sdk/api/python/errors#filepathinvaliderror-message) | property |
| [`FileSystemError`](/reference/sdk/api/python/errors#filesystemerror) | class |
| [`FileSystemError()`](/reference/sdk/api/python/errors#filesystemerror-constructor) | constructor |
| [`FileSystemError.message`](/reference/sdk/api/python/errors#filesystemerror-message) | property |
| [`get_compatible_model_version`](/reference/sdk/api/python/models-and-config#get_compatible_model_version) | function |
| [`get_sdk_version`](/reference/sdk/api/python/models-and-config#get_sdk_version) | function |
| [`InternalError`](/reference/sdk/api/python/errors#internalerror) | class |
| [`InternalError()`](/reference/sdk/api/python/errors#internalerror-constructor) | constructor |
| [`InternalError.message`](/reference/sdk/api/python/errors#internalerror-message) | property |
| [`LicenseExpiredError`](/reference/sdk/api/python/errors#licenseexpirederror) | class |
| [`LicenseExpiredError()`](/reference/sdk/api/python/errors#licenseexpirederror-constructor) | constructor |
| [`LicenseExpiredError.message`](/reference/sdk/api/python/errors#licenseexpirederror-message) | property |
| [`LicenseFormatInvalidError`](/reference/sdk/api/python/errors#licenseformatinvaliderror) | class |
| [`LicenseFormatInvalidError()`](/reference/sdk/api/python/errors#licenseformatinvaliderror-constructor) | constructor |
| [`LicenseFormatInvalidError.message`](/reference/sdk/api/python/errors#licenseformatinvaliderror-message) | property |
| [`LicenseVersionUnsupportedError`](/reference/sdk/api/python/errors#licenseversionunsupportederror) | class |
| [`LicenseVersionUnsupportedError()`](/reference/sdk/api/python/errors#licenseversionunsupportederror-constructor) | constructor |
| [`LicenseVersionUnsupportedError.message`](/reference/sdk/api/python/errors#licenseversionunsupportederror-message) | property |
| [`Model`](/reference/sdk/api/python/models-and-config#model) | class |
| [`Model.download`](/reference/sdk/api/python/models-and-config#model-download) | method |
| [`Model.download_async`](/reference/sdk/api/python/models-and-config#model-download_async) | method |
| [`Model.from_file`](/reference/sdk/api/python/models-and-config#model-from_file) | method |
| [`Model.get_id`](/reference/sdk/api/python/models-and-config#model-get_id) | method |
| [`Model.get_optimal_block_size`](/reference/sdk/api/python/models-and-config#model-get_optimal_block_size) | method |
| [`Model.get_optimal_sample_rate`](/reference/sdk/api/python/models-and-config#model-get_optimal_sample_rate) | method |
| [`ModelDataUnalignedError`](/reference/sdk/api/python/errors#modeldataunalignederror) | class |
| [`ModelDataUnalignedError()`](/reference/sdk/api/python/errors#modeldataunalignederror-constructor) | constructor |
| [`ModelDataUnalignedError.message`](/reference/sdk/api/python/errors#modeldataunalignederror-message) | property |
| [`ModelDownloadError`](/reference/sdk/api/python/errors#modeldownloaderror) | class |
| [`ModelDownloadError()`](/reference/sdk/api/python/errors#modeldownloaderror-constructor) | constructor |
| [`ModelDownloadError.details`](/reference/sdk/api/python/errors#modeldownloaderror-details) | property |
| [`ModelDownloadError.message`](/reference/sdk/api/python/errors#modeldownloaderror-message) | property |
| [`ModelInvalidError`](/reference/sdk/api/python/errors#modelinvaliderror) | class |
| [`ModelInvalidError()`](/reference/sdk/api/python/errors#modelinvaliderror-constructor) | constructor |
| [`ModelInvalidError.message`](/reference/sdk/api/python/errors#modelinvaliderror-message) | property |
| [`ModelTypeUnsupportedError`](/reference/sdk/api/python/errors#modeltypeunsupportederror) | class |
| [`ModelTypeUnsupportedError()`](/reference/sdk/api/python/errors#modeltypeunsupportederror-constructor) | constructor |
| [`ModelTypeUnsupportedError.message`](/reference/sdk/api/python/errors#modeltypeunsupportederror-message) | property |
| [`ModelVersionUnsupportedError`](/reference/sdk/api/python/errors#modelversionunsupportederror) | class |
| [`ModelVersionUnsupportedError()`](/reference/sdk/api/python/errors#modelversionunsupportederror-constructor) | constructor |
| [`ModelVersionUnsupportedError.message`](/reference/sdk/api/python/errors#modelversionunsupportederror-message) | property |
| [`NotInitializedError`](/reference/sdk/api/python/errors#notinitializederror) | class |
| [`NotInitializedError()`](/reference/sdk/api/python/errors#notinitializederror-constructor) | constructor |
| [`NotInitializedError.message`](/reference/sdk/api/python/errors#notinitializederror-message) | property |
| [`OtelConfig`](/reference/sdk/api/python/models-and-config#otelconfig) | class |
| [`OtelConfig()`](/reference/sdk/api/python/models-and-config#otelconfig-constructor) | constructor |
| [`OtelConfig.__repr__`](/reference/sdk/api/python/models-and-config#otelconfig-__repr__) | method |
| [`OtelConfig.enable`](/reference/sdk/api/python/models-and-config#otelconfig-enable) | property |
| [`OtelConfig.export_interval_ms`](/reference/sdk/api/python/models-and-config#otelconfig-export_interval_ms) | property |
| [`OtelConfig.session_id`](/reference/sdk/api/python/models-and-config#otelconfig-session_id) | property |
| [`ParameterFixedError`](/reference/sdk/api/python/errors#parameterfixederror) | class |
| [`ParameterFixedError()`](/reference/sdk/api/python/errors#parameterfixederror-constructor) | constructor |
| [`ParameterFixedError.message`](/reference/sdk/api/python/errors#parameterfixederror-message) | property |
| [`ParameterOutOfRangeError`](/reference/sdk/api/python/errors#parameteroutofrangeerror) | class |
| [`ParameterOutOfRangeError()`](/reference/sdk/api/python/errors#parameteroutofrangeerror-constructor) | constructor |
| [`ParameterOutOfRangeError.message`](/reference/sdk/api/python/errors#parameteroutofrangeerror-message) | property |
| [`ProcessingNotAllowedError`](/reference/sdk/api/python/errors#processingnotallowederror) | class |
| [`ProcessingNotAllowedError()`](/reference/sdk/api/python/errors#processingnotallowederror-constructor) | constructor |
| [`ProcessingNotAllowedError.message`](/reference/sdk/api/python/errors#processingnotallowederror-message) | property |
| [`Processor`](/reference/sdk/api/python/enhancement#processor) | class |
| [`Processor()`](/reference/sdk/api/python/enhancement#processor-constructor) | constructor |
| [`Processor.get_context`](/reference/sdk/api/python/enhancement#processor-get_context) | method |
| [`Processor.get_energy_vad_context`](/reference/sdk/api/python/enhancement#processor-get_energy_vad_context) | method |
| [`Processor.initialize`](/reference/sdk/api/python/enhancement#processor-initialize) | method |
| [`Processor.process`](/reference/sdk/api/python/enhancement#processor-process) | method |
| [`Processor.terminate_session`](/reference/sdk/api/python/enhancement#processor-terminate_session) | method |
| [`ProcessorAsync`](/reference/sdk/api/python/enhancement#processorasync) | class |
| [`ProcessorAsync()`](/reference/sdk/api/python/enhancement#processorasync-constructor) | constructor |
| [`ProcessorAsync.get_context`](/reference/sdk/api/python/enhancement#processorasync-get_context) | method |
| [`ProcessorAsync.get_energy_vad_context`](/reference/sdk/api/python/enhancement#processorasync-get_energy_vad_context) | method |
| [`ProcessorAsync.initialize_async`](/reference/sdk/api/python/enhancement#processorasync-initialize_async) | method |
| [`ProcessorAsync.process_async`](/reference/sdk/api/python/enhancement#processorasync-process_async) | method |
| [`ProcessorAsync.terminate_session_async`](/reference/sdk/api/python/enhancement#processorasync-terminate_session_async) | method |
| [`ProcessorConfig`](/reference/sdk/api/python/models-and-config#processorconfig) | class |
| [`ProcessorConfig()`](/reference/sdk/api/python/models-and-config#processorconfig-constructor) | constructor |
| [`ProcessorConfig.__repr__`](/reference/sdk/api/python/models-and-config#processorconfig-__repr__) | method |
| [`ProcessorConfig.block_size`](/reference/sdk/api/python/models-and-config#processorconfig-block_size) | property |
| [`ProcessorConfig.optimal`](/reference/sdk/api/python/models-and-config#processorconfig-optimal) | method |
| [`ProcessorConfig.sample_rate`](/reference/sdk/api/python/models-and-config#processorconfig-sample_rate) | property |
| [`ProcessorConfig.variable_block_size`](/reference/sdk/api/python/models-and-config#processorconfig-variable_block_size) | property |
| [`ProcessorContext`](/reference/sdk/api/python/enhancement#processorcontext) | class |
| [`ProcessorContext.get_audio_delay`](/reference/sdk/api/python/enhancement#processorcontext-get_audio_delay) | method |
| [`ProcessorContext.get_parameter`](/reference/sdk/api/python/enhancement#processorcontext-get_parameter) | method |
| [`ProcessorContext.parameter`](/reference/sdk/api/python/enhancement#processorcontext-parameter) | method |
| [`ProcessorContext.reset`](/reference/sdk/api/python/enhancement#processorcontext-reset) | method |
| [`ProcessorContext.set_parameter`](/reference/sdk/api/python/enhancement#processorcontext-set_parameter) | method |
| [`ProcessorContext.update_bearer_token`](/reference/sdk/api/python/enhancement#processorcontext-update_bearer_token) | method |
| [`ProcessorParameter`](/reference/sdk/api/python/enhancement#processorparameter) | class |
| [`ProcessorParameter.Bypass`](/reference/sdk/api/python/enhancement#processorparameter-bypass) | enum member |
| [`ProcessorParameter.EnhancementLevel`](/reference/sdk/api/python/enhancement#processorparameter-enhancementlevel) | enum member |
| [`ProcessorParameter.VoiceGain`](/reference/sdk/api/python/enhancement#processorparameter-voicegain) | enum member |
| [`TokenUnsupportedError`](/reference/sdk/api/python/errors#tokenunsupportederror) | class |
| [`TokenUnsupportedError()`](/reference/sdk/api/python/errors#tokenunsupportederror-constructor) | constructor |
| [`TokenUnsupportedError.message`](/reference/sdk/api/python/errors#tokenunsupportederror-message) | property |
| [`UnknownError`](/reference/sdk/api/python/errors#unknownerror) | class |
| [`UnknownError()`](/reference/sdk/api/python/errors#unknownerror-constructor) | constructor |
| [`UnknownError.error_code`](/reference/sdk/api/python/errors#unknownerror-error_code) | property |
| [`UnknownError.message`](/reference/sdk/api/python/errors#unknownerror-message) | property |
| [`Vad`](/reference/sdk/api/python/vad#vad) | class |
| [`Vad()`](/reference/sdk/api/python/vad#vad-constructor) | constructor |
| [`Vad.get_context`](/reference/sdk/api/python/vad#vad-get_context) | method |
| [`Vad.initialize`](/reference/sdk/api/python/vad#vad-initialize) | method |
| [`Vad.process`](/reference/sdk/api/python/vad#vad-process) | method |
| [`Vad.terminate_session`](/reference/sdk/api/python/vad#vad-terminate_session) | method |
| [`VadAsync`](/reference/sdk/api/python/vad#vadasync) | class |
| [`VadAsync()`](/reference/sdk/api/python/vad#vadasync-constructor) | constructor |
| [`VadAsync.get_context`](/reference/sdk/api/python/vad#vadasync-get_context) | method |
| [`VadAsync.initialize_async`](/reference/sdk/api/python/vad#vadasync-initialize_async) | method |
| [`VadAsync.process_async`](/reference/sdk/api/python/vad#vadasync-process_async) | method |
| [`VadAsync.terminate_session_async`](/reference/sdk/api/python/vad#vadasync-terminate_session_async) | method |
| [`VadContext`](/reference/sdk/api/python/vad#vadcontext) | class |
| [`VadContext.get_parameter`](/reference/sdk/api/python/vad#vadcontext-get_parameter) | method |
| [`VadContext.get_prediction_delay`](/reference/sdk/api/python/vad#vadcontext-get_prediction_delay) | method |
| [`VadContext.is_speech_detected`](/reference/sdk/api/python/vad#vadcontext-is_speech_detected) | method |
| [`VadContext.parameter`](/reference/sdk/api/python/vad#vadcontext-parameter) | method |
| [`VadContext.raw_vad_probability`](/reference/sdk/api/python/vad#vadcontext-raw_vad_probability) | method |
| [`VadContext.reset`](/reference/sdk/api/python/vad#vadcontext-reset) | method |
| [`VadContext.set_parameter`](/reference/sdk/api/python/vad#vadcontext-set_parameter) | method |
| [`VadContext.update_bearer_token`](/reference/sdk/api/python/vad#vadcontext-update_bearer_token) | method |
| [`VadParameter`](/reference/sdk/api/python/vad#vadparameter) | class |
| [`VadParameter.MinimumSpeechDuration`](/reference/sdk/api/python/vad#vadparameter-minimumspeechduration) | enum member |
| [`VadParameter.Sensitivity`](/reference/sdk/api/python/vad#vadparameter-sensitivity) | enum member |
| [`VadParameter.SpeechHoldDuration`](/reference/sdk/api/python/vad#vadparameter-speechholdduration) | enum member |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.