Components

preTranslation

  • allowLineBreaks: boolean | object<schema:string?> (optional)

  • excludeStrings: string | object<schema:string?> (optional)

  • regexpMatch: string

  • regexpReplace: string

{
    "components": {
        "preTranslation":{
            "regexpReplace": "[\"\\n\", \"g\", \"\\\\n \"]"
        }
    }
}

postTranslation

  • regexpMatch: string

  • regexpReplace: string

{
    "components": {
        "postTranslation": {
            "regexpReplace": "[\"\\\\\\\\n\", \"g\", \"\\n\"]"
        }
    }
}

conversationMemory

  • schema: array[] => object<type?, name?, default?>

    • status: boolean

    • initialPrompt: string

    • systemTemplate: string

    • userTemplate: string

    • assistantTemplate: string

    • dataSource: string

    • maxEntries: number

  • formBuilder: array[] (optional)

  • components: object <schema:string?>

{
    "schema": {
        { "type": "boolean", "name": "conversationMemory.status", "default": true },
        { "type": "string", "name": "conversationMemory.initial_prompt", "default": "" },
        { "type": "string", "name": "conversationMemory.system_template", "default": "" },
        { "type": "string", "name": "conversationMemory.user_template", "default": "" },
        { "type": "string", "name": "conversationMemory.assistant_template", "default": "" },
        { "type": "string", "name": "conversationMemory.data_source", "default": "TM" },
        { "type": "number", "name": "conversationMemory.max_entries", "default": "20" }
    },
    "components": {
        "conversationMemory": {
            "schema": "conversationMemory"
        }
    }
}

usageChecker

  • interval: number

  • format: string

  • request: object <method:string?, url:string?, responseCountQuery:string?, responseLimitQuery:string?>

{
    "components": {
        "usageChecker": {
            "interval": 60000,
            "format": "( $COUNT / $LIMIT )",
            "request": {
                "method": "http_get",
                "url": "https://api.deepl.com/v2/usage?auth_key=$API_KEY",
                "responseCountQuery": "character_count",
                "responseLimitQuery": "character_limit"
            }        
        }
    }
}

interceptorRequest

  • prependSourceText: object <status:bool?, value:string?>

  • appendSourceText: object <status:bool?, value:string?

  • replaceSourceText: object

{
    "schema": {
        { "type": "boolean", "name": "interceptorRequest.prependSourceText", "default": false },
        { "type": "string", "name": "prompt", "default": "Translate the following text from $SOURCE_LANG to $TARGET_LANG: " }
    },
    "components": {
        "interceptorRequest":{
            "prependSourceText": {
                "status": false,
                "value": "$PROMPT"
            }         
        }
    }
}

Last updated