Skip to content

eleanor.backend.api.v1

Version 1 of the Eleanor Framework API.

Attributes

agent_path_param module-attribute 

agent_path_param = Path(
    ...,
    title="Agent PKID",
    description="Primary key or name identifier for agent resource",
    examples=[
        "participant.c40f24decacc4512abca47d2e3c30ed6",
        "participant.d839e6dc118f4517830f6ff7d0b93ab7",
    ],
)

checkmate_queue_query_param module-attribute 

checkmate_queue_query_param = Query(
    default=None,
    title="Queue",
    description="CheckMate queue name",
)

checkmate_tags_query_param module-attribute 

checkmate_tags_query_param = Query(
    default=None,
    title="Tags",
    description="CheckMate task tag(s)",
)

collection_path_param module-attribute 

collection_path_param = Path(
    ...,
    title="User PKID",
    description="Primary key or name identifier for memory collection resource",
    examples=[
        "memory_collection.18c5b9eff75647708f2f399854fa269a",
        "memory_collection.232cf2e08c5042ce94cc6e4f0e744670",
    ],
)

dry_run_query_param module-attribute 

dry_run_query_param = Query(
    default=True,
    title="Dry Run",
    description="When set to True, no write operations will be performed, operation will be simulated. Intended use case is to prevent accidental execution of destructive operations or testing.",
)

memory_path_param module-attribute 

memory_path_param = Path(
    ...,
    title="Memory PKID",
    description="Primary key or name identifier for a memory resource",
    examples=[
        "memory.0005ba2fdfe94651ad5caa2b027d046e",
        "memory.000644e020fa431e9b2b60320bf94c64",
    ],
)

namespace_path_param module-attribute 

namespace_path_param = Path(
    ...,
    title="Namespace",
    description="Primary key or name identifier for namespace resource",
    examples=[
        "namespace.e915f6ff8ad949b3865842771d1f52b3",
        "default",
    ],
)

participant_path_param module-attribute 

participant_path_param = Path(
    ...,
    title="Participant PKID",
    description="Primary key or name identifier for participant resource. Participants can be either agents or users.",
    examples=[
        "participant.2878466fd5714c418e579800b0d43e2f",
        "participant.2aadf144ff0e4fdf88937072fb951078",
    ],
)

session_path_param module-attribute 

session_path_param = Path(
    ...,
    title="Activity Session",
    description="Primary key or name identifier for an activity session resource",
    examples=[
        "activity_session.012b3b6f242147158706d6377b566446",
        "session-20241126053718",
    ],
)

user_path_param module-attribute 

user_path_param = Path(
    ...,
    title="User PKID",
    description="Primary key or name identifier for user resource",
    examples=[
        "participant.e4ee9fdce2964e3db16ecc3076e875fc",
        "participant.ffbe10594a454a218c54834592ef8786",
    ],
)