aiq.front_ends.fastapi.fastapi_front_end_plugin_worker#

Attributes#

logger

Classes#

FastApiFrontEndPluginWorkerBase

Helper class that provides a standard way to create an ABC using

RouteInfo

FastApiFrontEndPluginWorker

Helper class that provides a standard way to create an ABC using

Module Contents#

logger#
class FastApiFrontEndPluginWorkerBase(
config: aiq.data_models.config.AIQConfig,
)#

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

_config#
_front_end_config#
property config: aiq.data_models.config.AIQConfig#
property front_end_config: aiq.front_ends.fastapi.fastapi_front_end_config.FastApiFrontEndConfig#
build_app() → fastapi.FastAPI#
abstractmethod configure(
app: fastapi.FastAPI,
builder: aiq.builder.workflow_builder.WorkflowBuilder,
)#
Async:

abstractmethod get_step_adaptor() → aiq.front_ends.fastapi.step_adaptor.StepAdaptor#
class RouteInfo(/, **data: Any)#

Bases: pydantic.BaseModel

function_name: str | None#
class FastApiFrontEndPluginWorker(config: aiq.data_models.config.AIQConfig)#

Bases: FastApiFrontEndPluginWorkerBase

Helper class that provides a standard way to create an ABC using inheritance.

get_step_adaptor() → aiq.front_ends.fastapi.step_adaptor.StepAdaptor#
async configure(
app: fastapi.FastAPI,
builder: aiq.builder.workflow_builder.WorkflowBuilder,
)#
async add_routes(
app: fastapi.FastAPI,
builder: aiq.builder.workflow_builder.WorkflowBuilder,
)#
async add_default_route(
app: fastapi.FastAPI,
session_manager: aiq.runtime.session.AIQSessionManager,
)#
async add_route(
app: fastapi.FastAPI,
endpoint: aiq.front_ends.fastapi.fastapi_front_end_config.FastApiFrontEndConfig.EndpointBase,
session_manager: aiq.runtime.session.AIQSessionManager,
)#