assistant.bones.actions
=======================

.. py:module:: assistant.bones.actions

.. autoapi-nested-parse::

   Bone Actions

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

   Examples:
   ~~~~~~~~~

       .. code-block:: python

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

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



Attributes
----------

.. autoapisummary::

   assistant.bones.actions.BONE_ACTION_KEY


Classes
-------

.. autoapisummary::

   assistant.bones.actions.BoneAction


Module Contents
---------------

.. py:data:: BONE_ACTION_KEY
   :type:  Final[str]
   :value: 'actions'


   The key of the parameter


.. py:class:: BoneAction

   .. py:attribute:: TRANSLATE
      :type:  Final[str]
      :value: 'translate'


      Translate text



   .. py:attribute:: DESCRIBE_IMAGE
      :type:  Final[str]
      :value: 'describe_image'


      Describe image with an alt text