Skip to content

from promplate import *#

Context module-attribute #

Context = dict[str, Any]

BaseCallback #

Bases: Protocol

pre_process #

pre_process(context: ChainContext) -> Context | Awaitable[Context | None] | None

mid_process #

mid_process(context: ChainContext) -> Context | Awaitable[Context | None] | None

end_process #

end_process(context: ChainContext) -> Context | Awaitable[Context | None] | None

on_enter #

on_enter(node: Interruptible, context: Context | None, config: Context) -> tuple[Context | None, Context]

on_leave #

on_leave(node: Interruptible, context: ChainContext, config: Context) -> tuple[ChainContext, Context]

Callback #

Bases: BaseCallback

__init__ #

__init__(*, pre_process: Process | AsyncProcess | None = None, mid_process: Process | AsyncProcess | None = None, end_process: Process | AsyncProcess | None = None, on_enter: Callable[[Interruptible, Context | None, Context], tuple[Context | None, Context]] | None = None, on_leave: Callable[[Interruptible, ChainContext, Context], tuple[ChainContext, Context]] | None = None)

pre_process #

pre_process(context)

mid_process #

mid_process(context)

end_process #

end_process(context)

on_enter #

on_enter(node, context, config)

on_leave #

on_leave(node, context, config)

Chain #

Bases: Interruptible

nodes instance-attribute #

nodes = list(nodes)

callbacks instance-attribute #

callbacks: list[BaseCallback | type[BaseCallback]] = []

__init__ #

__init__(*nodes: AbstractNode, partial_context: Context | None = None)

__iadd__ #

__iadd__(chain: AbstractNode)

__iter__ #

__iter__()

__repr__ #

__repr__()

ChainContext #

Bases: SafeChainMapContext

result deletable property writable #

result

__init__ #

__init__(least: MutableMapping | None = None, *maps: Mapping)

__new__ #

__new__()

__new__(least: C, *maps: Mapping) -> C

__new__(least: MutableMapping | None = None, *maps: Mapping)

__new__(*args, **kwargs)

ensure classmethod #

ensure(context)

__str__ #

__str__()

Jump #

Bases: Exception

into instance-attribute #

into = into

out_of instance-attribute #

out_of = out_of

__init__ #

__init__(into: Interruptible | None = None, out_of: Interruptible | None = None)

__str__ #

__str__()

Loop #

Bases: Interruptible

chain instance-attribute #

chain = chain

callbacks instance-attribute #

callbacks: list[BaseCallback | type[BaseCallback]] = []

__init__ #

__init__(chain: AbstractNode, partial_context: Context | None = None)

Node #

Bases: Loader, Interruptible

template instance-attribute #

template = Template(template) if isinstance(template, str) else template

callbacks instance-attribute #

callbacks: list[BaseCallback | type[BaseCallback]] = []

llm instance-attribute #

llm = llm

run_config instance-attribute #

run_config = config

__init__ #

__init__(template: Template | str, partial_context: Context | None = None, llm: LLM | None = None, **config)

render #

render(context: Context | None = None, callbacks: list[BaseCallback] | None = None)

arender async #

arender(context: Context | None = None, callbacks: list[BaseCallback] | None = None)

__str__ #

__str__()

Message #

Bases: TypedDict

role instance-attribute #

role: Role

content instance-attribute #

content: str

name instance-attribute #

name: NotRequired[str]

Template #

Bases: TemplateCore, Loader

context instance-attribute #

context = {} if context is None else context

__init__ #

__init__(text: str, /, context: Context | None = None)

render #

render(context: Context | None = None)

arender async #

arender(context: Context | None = None)

parse_chat_markup #

parse_chat_markup(text: str) -> list[Message]