Context Utils

This module defines classes used by Context.

The most important ones here are FrameworkData and ContextMainInfo that define all non-turn related data stored in contexts.

exception ContextError

Bases: Exception

Raised when context methods are not used correctly.

class ServiceState(**data)

Bases: BaseModel

execution_status: ComponentExecutionState

ComponentExecutionState of this pipeline service. Cleared at the end of every turn.

finished_event: Event

Asyncio Event which can be awaited until this service finishes. Cleared at the end of every turn.

class FrameworkData(**data)

Bases: BaseModel

Framework uses this to store data related to any of its modules.

service_states: Dict[str, ServiceState]

Dictionary containing ServiceState of all the pipeline components. Cleared at the end of every turn.

current_node: Optional[Node]

A copy of the current node provided by get_inherited_node(). This node can be safely modified by Processing functions to alter current node fields.

pipeline: Optional[Pipeline]

Instance of the pipeline that manages this context. Can be used to obtain run configuration such as script or fallback label.

stats: Dict[str, Any]

Enables complex stats collection across multiple turns.

slot_manager: SlotManager

Stores extracted slots.

class ContextMainInfo(**data)

Bases: BaseModel

Main context fields, that are stored in MAIN table. For most of the database backends, it will be serialized to json. For SQL database backends, it will be written to different table columns. For memory context storage, it won’t be serialized at all.

current_turn_id: int

Current turn number, specifies the last turn number, that is also the last turn available in labels, requests, and responses.

created_at: int

Timestamp when the context was first time saved to database. It is set (and managed) by DBContextStorage.

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Return type:

None

Args:

self: The BaseModel instance. context: The context.

updated_at: int

Timestamp when the context was last time saved to database. It is set (and managed) by DBContextStorage.

misc: Dict[str, Any]

misc stores any custom data. The framework doesn’t use this dictionary, so storage of any data won’t reflect on the work of the internal Chatsky functions.

• key - Arbitrary data name.

• value - Arbitrary data.

framework_data: FrameworkData

This attribute is used for storing custom data required for pipeline execution. It is meant to be used by the framework only. Accessing it may result in pipeline breakage.

origin_interface: Optional[str]

Name of the interface that produced the first request in this context.

_misc_adaptor: TypeAdapter[Dict[str, Any]] = ModelPrivateAttr(default=<pydantic.type_adapter.TypeAdapter object>)

classmethod _validate_framework_data(value)

Return type:

Dict

_serialize_misc(misc)

Return type:

bytes

_serialize_framework_data(framework_data)

Return type:

bytes