assistant.bones.actions¶

Bone Actions

This module defines identifiers as they are used in vi-admin to activate certain additional actions on a bone.

Examples:¶

descr = TextBone(
    languages=["de", "en"],
    params={
        BONE_ACTION_KEY: [BoneAction.TRANSLATE],
    },
)

image = ImageBone(
    params={
        BONE_ACTION_KEY: [BoneAction.DESCRIBE_IMAGE],
    },
)

Attributes¶

BONE_ACTION_KEY

The key of the parameter

Classes¶

BoneAction

Module Contents¶

assistant.bones.actions.BONE_ACTION_KEY: Final[str] = 'actions'¶: The key of the parameter

class assistant.bones.actions.BoneAction¶

TRANSLATE: Final[str] = 'translate'¶: Translate text

DESCRIBE_IMAGE: Final[str] = 'describe_image'¶: Describe image with an alt text