Docs /Templates/ sinapsis-openai

OpenAIAudioTranscriptionWrapper

sinapsis-openaiOpenAIdynamicopenaiprompttext

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 set

Installation

Install the published package using pip or uv.

Terminalbash
pip install sinapsis-openai==1.0.0
uv pip install sinapsis-openai==1.0.0
uv add sinapsis-openai==1.0.0

Configuration

Effective fields from the inspector schema, including nested Pydantic model fields.

modelRequired
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

typing.Literal['whisper-1', 'gpt-transcribe', 'gpt-4o-transcribe', 'gpt-4o-mini-transcribe', 'gpt-4o-mini-transcribe-2025-12-15', 'gpt-4o-transcribe-diarize']
Required
Default: null
createRequired
createAttributes
Required
Default: null
prompt
Any
Optional
Default: null
stream
Any
Optional
Default: null
include
Any
Optional
Default: null
timeout
Any
Optional
Default: null
keywords
Any
Optional
Default: null
language
Any
Optional
Default: null
languages
Any
Optional
Default: null
extra_body
Any
Optional
Default: null
extra_query
Any
Optional
Default: null
temperature
Any
Optional
Default: null
extra_headers
Any
Optional
Default: null
response_format
Any
Optional
Default: null
chunking_strategy
Any
Optional
Default: null
known_speaker_names
Any
Optional
Default: null
timestamp_granularities
Any
Optional
Default: null
known_speaker_references
Any
Optional
Default: null
metadata
sinapsis_core.template_base.base_models.TemplateMetadata | None
Optional
Default: null
openai_initRequired
__init__Attributes
Required
Default: null
api_key
typing.Union[str, typing.Callable[[], str], NoneType]
Optional
Default: null
project
typing.Optional[str]
Optional
Default: null
timeout
Any
Optional
Default: null
base_url
Any
Optional
Default: null
provider
Any
Optional
Default: null
http_client
Any
Optional
Default: null
max_retries
int
Optional
Default: 2
organization
typing.Optional[str]
Optional
Default: null
admin_api_key
typing.Optional[str]
Optional
Default: null
default_query
typing.Optional[typing.Mapping[str, object]]
Optional
Default: null
webhook_secret
typing.Optional[str]
Optional
Default: null
default_headers
typing.Optional[typing.Mapping[str, str]]
Optional
Default: null
workload_identity
Any
Optional
Default: null
websocket_base_url
Any
Optional
Default: null

Configuration example

Example from the Python docstring:

yaml
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: en
Show schema-based configuration skeleton
yaml
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

Immediate parent: sinapsis_openai.templates.openai_audio.OpenAIAudioTranscription

Environment variables

Environment definitions belong to their canonical Python modules.

SINAPSIS_BUILD_DOCS · defined elsewhere