Pipeline#

dff.pipeline.service.group

The Service Group module contains the ServiceGroup class, which is used to represent a group of related services. This class provides a way to organize and manage multiple services as a single unit, allowing for easier management and organization of the services within the pipeline. The ServiceGroup serves the important function of grouping services to work together in parallel.

dff.pipeline.conditions

The conditions module contains functions that can be used to determine whether the pipeline component to which they are attached should be executed or not. The standard set of them allows user to setup dependencies between pipeline components.

dff.pipeline.pipeline.utils

The Utils module contains several service functions that are commonly used throughout the framework. These functions provide a variety of utility functionality.

dff.pipeline.service.extra

The Extra Handler module contains additional functionality that extends the capabilities of the system beyond the core functionality. Extra handlers is an input converting addition to PipelineComponent. For example, it is used to grep statistics from components, timing, logging, etc.

dff.pipeline.types

The Types module contains several classes and special types that are used throughout the DFF Pipeline. The classes and special types in this module can include data models, data structures, and other types that are defined for type hinting.

dff.pipeline.pipeline.component

The Component module defines a PipelineComponent class, which is a fundamental building block of the framework. A PipelineComponent represents a single step in a processing pipeline, and is responsible for performing a specific task or set of tasks.

dff.pipeline.pipeline.pipeline

The Pipeline module contains the Pipeline class, which is a fundamental element of the DFF. The Pipeline class is responsible for managing and executing the various components (PipelineComponent)which make up the processing of messages from and to users. It provides a way to organize and structure the messages processing flow. The Pipeline class is designed to be highly customizable and configurable, allowing developers to add, remove, or modify the components that make up the messages processing flow.

dff.pipeline.service.service

The Service module contains the Service class, which can be included into pipeline as object or a dictionary. Pipeline consists of services and service groups. Service group can be synchronous or asynchronous. Service is an atomic part of a pipeline. Service can be asynchronous only if its handler is a coroutine. Actor wrapping service is asynchronous.

dff.pipeline.pipeline.actor

Actor is a component of Pipeline, that contains the Script and handles it. It is responsible for processing user input and determining the appropriate response based on the current state of the conversation and the script. The actor receives requests in the form of a Context class, which contains information about the user's input, the current state of the conversation, and other relevant data.

dff.pipeline.service.utils

The Utility Functions module contains several utility functions that are commonly used throughout the DFF. These functions provide a variety of utility functionality.