OpenAIAudioTranscriptionWrapper
Python template · sinapsis_openai.templates.openai_audio
Overview
Template that wraps the `OpenAI.audio.transcriptions.create` API endpoint to perform audio transcription tasks. This template excludes the `file` attribute (expected to be provided via the DataContainer packet `source`) and the `model` attribute (which is set in the template `AttributesBaseModel`) from the API caller. This ensures that the file path is dynamically extracted from the data packet and that the audio model is configured exclusively through the template attributes. PACKET_TYPE_NAME indicates that this template process AudioPackets stored in the audio field of DataContainer
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-openai==1.0.0uv pip install sinapsis-openai==1.0.0uv add sinapsis-openai==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
The model to use for audio transcription. openai_init api_key typing.Union[str, typing.Callable[[], str], NoneType]: default: None admin_api_key typing.Optional[str]: default: None workload_identity typing.Any:… Read full field description
The model to use for audio transcription. openai_init api_key typing.Union[str, typing.Callable[[], str], NoneType]: default: None admin_api_key typing.Optional[str]: default: None workload_identity typing.Any: default: None organization typing.Optional[str]: default: None project typing.Optional[str]: default: None webhook_secret typing.Optional[str]: default: None provider typing.Any: default: None base_url typing.Any: default: None websocket_base_url typing.Any: default: None timeout typing.Any: default: NOT_GIVEN max_retries <class 'int'>: default: 2 default_headers typing.Optional[typing.Mapping[str, str]]: default: None default_query typing.Optional[typing.Mapping[str, object]]: default: None http_client typing.Any: default: None _strict_response_validation <class 'bool'>: default: False _enforce_credentials <class 'bool'>: default: Truecreate chunking_strategy typing.Any: default: <openai.Omit object at 0x74f9db285a90> include typing.Any: default: <openai.Omit object at 0x74f9db285a90> keywords typing.Any: default: <openai.Omit object at 0x74f9db285a90> known_speaker_names typing.Any: default: <openai.Omit object at 0x74f9db285a90> known_speaker_references typing.Any: default: <openai.Omit object at 0x74f9db285a90> language typing.Any: default: <openai.Omit object at 0x74f9db285a90> languages typing.Any: default: <openai.Omit object at 0x74f9db285a90> prompt typing.Any: default: <openai.Omit object at 0x74f9db285a90> response_format typing.Any: default: <openai.Omit object at 0x74f9db285a90> stream typing.Any: default: <openai.Omit object at 0x74f9db285a90> temperature typing.Any: default: <openai.Omit object at 0x74f9db285a90> timestamp_granularities typing.Any: default: <openai.Omit object at 0x74f9db285a90> extra_headers typing.Any: default: None extra_query typing.Any: default: None extra_body typing.Any: default: None timeout typing.Any: default: NOT_GIVEN
Required
Default: null
Required
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Required
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: 2
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Optional
Default: null
Configuration example
Example from the Python docstring:
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: OpenAIAudioTranscriptionWrapper
class_name: OpenAIAudioTranscriptionWrapper
template_input: InputTemplate
attributes:
model: 'whisper-1'
openai_init:
api_key: openai_api_key
max_retries: 2
create:
language: enShow schema-based configuration skeleton
templates:
- template_name: "OpenAIAudioTranscriptionWrapper"
class_name: "OpenAIAudioTranscriptionWrapper"
attributes:
model: "<required>"
create:
prompt: null
stream: null
include: null
timeout: null
keywords: null
language: null
languages: null
extra_body: null
extra_query: null
temperature: null
extra_headers: null
response_format: null
chunking_strategy: null
known_speaker_names: null
timestamp_granularities: null
known_speaker_references: null
openai_init:
api_key: null
project: null
timeout: null
base_url: null
provider: null
http_client: null
max_retries: 2
organization: null
admin_api_key: null
default_query: null
webhook_secret: null
default_headers: null
workload_identity: null
websocket_base_url: null
Inheritance
sinapsis_openai.templates.openai_audio.OpenAIAudioTranscriptionEnvironment variables
Environment definitions belong to their canonical Python modules.