Skip to main content

portia.execution_agents.output

Outputs from a plan run step.

These are stored and can be used as inputs to future steps

BaseOutput Objects​

class BaseOutput(BaseModel)

Base interface for concrete output classes to implement.

get_value​

@abstractmethod
def get_value() -> Serializable | None

Return the value of the output.

This should not be so long that it is an issue for LLM prompts.

serialize_value​

@abstractmethod
def serialize_value() -> str

Serialize the value to a string.

full_value​

@abstractmethod
def full_value(agent_memory: AgentMemory) -> Serializable | None

Get the full value, fetching from remote storage or file if necessary.

This value may be long and so is not suitable for use in LLM prompts.

get_summary​

@abstractmethod
def get_summary() -> str | None

Return the summary of the output.

LocalDataValue Objects​

class LocalDataValue(BaseOutput)

Output that is stored locally.

get_value​

def get_value() -> Serializable | None

Get the value of the output.

serialize_value​

def serialize_value() -> str

Serialize the value to a string.

full_value​

def full_value(agent_memory: AgentMemory) -> Serializable | None

Return the full value.

As the value is stored locally, this is the same as get_value() for this type of output.

get_summary​

def get_summary() -> str | None

Return the summary of the output.

serialize_value_field​

@field_serializer("value")
def serialize_value_field(value: Serializable | None) -> str

Serialize the value to a string.

Arguments:

  • value SERIALIZABLE_TYPE_VAR | None - The value to serialize.

Returns:

  • str - The serialized value as a string.

AgentMemoryValue Objects​

class AgentMemoryValue(BaseOutput)

Output that is stored in agent memory.

get_value​

def get_value() -> Serializable | None

Return the summary of the output as the value is too large to be retained locally.

serialize_value​

def serialize_value() -> str

Serialize the value to a string.

We use the summary as the value is too large to be retained locally.

full_value​

def full_value(agent_memory: AgentMemory) -> Serializable | None

Get the full value, fetching from remote storage or file if necessary.

get_summary​

def get_summary() -> str

Return the summary of the output.

LocalOutput Objects​

@deprecated(
    "LocalOutput is deprecated and will be removed in the 0.4 release - "
    "use LocalDataValue instead"
)
class LocalOutput(LocalDataValue)

Alias of LocalDataValue kept for backwards compatibility.

AgentMemoryOutput Objects​

@deprecated(
    "AgentMemoryOutput is deprecated and will be removed in the 0.4 release - "
    "use AgentMemoryValue instead"
)
class AgentMemoryOutput(AgentMemoryValue)

Alias of AgentMemoryValue kept for backwards compatibility.