GitHub

API reference for Prompt.

A conversation: its messages, in order.

Attributes

AttributeTypeDescription
contenttuple[Message, ...]

Functions

__init__

__init__(content) -> None
ParameterTypeDescription
contenttuple[Message, ...]

pipe

pipe[B](f) -> B
ParameterTypeDescription
fCallable[[Self], B]

Returns B

def pipe[B](self, f: Callable[[Self], B], /) -> B:
    return f(self)

concat

concat(input) -> Prompt

This prompt's messages, then input's.

ParameterTypeDescription
inputRawInput

Returns Prompt

def concat(self, input: RawInput) -> Prompt:
    """This prompt's messages, then ``input``'s."""
    other = make(input)
    if not self.content:
        return other
    if not other.content:
        return self
    return Prompt((*self.content, *other.content))

set_system

set_system(content) -> Prompt

A system message content first, replacing every other one.

ParameterTypeDescription
contentstr

Returns Prompt

def set_system(self, content: str) -> Prompt:
    """A system message ``content`` first, replacing every other one."""
    return Prompt(
        (
            SystemMessage(content=content),
            *(m for m in self.content if not isinstance(m, SystemMessage)),
        )
    )

prepend_system

prepend_system(content) -> Prompt

A leading system message: content before the first system message's text (Effect keeps that message too).

ParameterTypeDescription
contentstr

Returns Prompt

def prepend_system(self, content: str) -> Prompt:
    """A leading system message: ``content`` before the first system
    message's text (Effect keeps that message too)."""
    first = next((m for m in self.content if isinstance(m, SystemMessage)), None)
    system = SystemMessage(content=content if first is None else content + first.content)
    return Prompt((system, *self.content))

append_system

append_system(content) -> Prompt

A leading system message: the first system message's text, then content (Effect keeps that message too).

ParameterTypeDescription
contentstr

Returns Prompt

def append_system(self, content: str) -> Prompt:
    """A leading system message: the first system message's text, then
    ``content`` (Effect keeps that message too)."""
    first = next((m for m in self.content if isinstance(m, SystemMessage)), None)
    system = SystemMessage(content=content if first is None else first.content + content)
    return Prompt((system, *self.content))