Speech Tiles Developer Area, BZVoiceFlow Developer Guide

{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://speechtiles.com/draft/schemas/AudioToTextMap.schema.json",
    "copyrightNotice": "© Speech Tiles LLC. 2024, All rights reserved.",
    "title": "Audio Files Mapping to Text Strings",
    "description": "Version 1.1; last updated 02/23/2024. This document contains schema for mapping audio file names to corresponding text strings which can be synthesized for audio playback to replace audio playback of the recorded audio files. Unless documented otherwise, value of properties that are of type \"string\" can be updated at runtime by an application if their value is entered as a field name wrapped by \"$[\" and \"]\". If a property is of a type other than \"string\", then an additional property of type \"string\" with the same property name appended with the string \"Runtime\" is added to have its value entered as a field name wrapped by \"$[\" and \"]\". This allows the application to set the value of the field name at runtime to be the value of the original non-runtime property. Valid values of runtime fields override the values of non-runtime properties.",
    
    "type": "array",
    "items": {
        "description": "Array of Audio to Text modules that map audio file names to text Strings.",
        "type": "object",
        "properties": {
            "_COMMENT_": {
                "description": "Placeholder for entering a comment. Voiceflow processing ignores this property.",
                "type": "string"
            },
            "_audioFile": {
                "description": "Placeholder for documenting or noting other audioFile options. Voice Flow processing ignores this property.",
                "type": "string"
            },
            "audioFile": {
                "description": "Audio File Name. The value cannot be set at runtime. Example: \"Hello.wav\". ",
                "type": "string"
            },
            "_textString": {
                "description": "Placeholder for documenting or noting other textString options. Voice Flow processing ignores this property.",
                "type": "string"
            },
            "textString": {
                "description": "A text string to be speech synthesized for audio playback to replace audio playback of invalid value for \"audioFile\" property. The value can be set at runtime using \"$[<FieldName>]\" entry convention. Example: \"Hello there\". Runtime example: \"$[TextToSpeak]\".",
                "type": "string"
            },
            "textLanguageCode": {
                "description": "The language locale code of the text in \"textString\" property. The value can be set at runtime using \"$[<FieldName>]\" entry convention. Default: \"en-US\". Runtime example: \"$[LanguageCode]\".",
                "type": "string"
            }
        },
        "required": ["audioFile", "textString"],
        "additionalProperties": false
    }
}

Speech Tiles Developers

Conversational Speech Frameworks

Speech Tiles
Developers

Conversational Speech Frameworks

Conversational Speech Frameworks

BZVoiceFlow Framework Reference
1.2.0
AudioToTextMap JSON Schema

BZVoiceFlow Framework Reference 1.2.0 AudioToTextMap JSON Schema

BZVoiceFlow Framework Reference
1.2.0
AudioToTextMap JSON Schema