PromptChain

View module source on GitHub

​

AgentCost

class AgentCost(TypedDict)

Type definition for agent execution costs.

Attributes:

​

AgentUsage

class AgentUsage(TypedDict)

Type definition for agent token usage statistics.

Attributes:

​

AgentResponseMeta

class AgentResponseMeta(TypedDict)

Type definition for agent response metadata.

Attributes:

​

AgentResponse

@dataclass
class AgentResponse()

Represents a complete agent response with metadata.

This class encapsulates both the actual response content and associated metadata including cost, usage statistics, and contextual information.

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "AgentResponse"

Create an AgentResponse instance from a dictionary.

Arguments:

Returns:

​

PromptNode

@dataclass
class PromptNode()

Node containing a prompt in a prompt chain.

This node type wraps a Prompt object and represents a step in the chain that executes a prompt.

Attributes:

​

CodeBlockNode

@dataclass
class CodeBlockNode()

Node containing executable code in a prompt chain.

This node type contains code that can be executed as part of the prompt chain workflow.

Attributes:

​

ApiParams

@dataclass
class ApiParams()

Parameters for API node configuration.

Attributes:

​

ApiNode

@dataclass
class ApiNode()

Node containing API configuration in a prompt chain.

This node type wraps API configuration and represents a step in the chain that makes an API call.

Attributes:

​

Node

@dataclass
class Node()

Generic node in a prompt chain.

A Node represents a single step in a prompt chain and can contain different types of content (prompt, code, or API configuration).

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "Node"

Create a Node instance from a dictionary.

Arguments:

Returns:

​

PromptChain

@dataclass
class PromptChain()

Complete prompt chain with versioning information.

A PromptChain represents a complete workflow consisting of multiple nodes that are executed in sequence. Each chain has versioning information for tracking changes over time.

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "PromptChain"

Create a PromptChain instance from a dictionary.

Arguments:

Returns:

​

PromptChainVersionConfig

@dataclass
class PromptChainVersionConfig()

Configuration for a specific prompt chain version.

Contains the actual configuration data (nodes) for a particular version of a prompt chain.

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "PromptChainVersionConfig"

Create a PromptChainVersionConfig instance from a dictionary.

Arguments:

Returns:

​

PromptChainVersion

@dataclass
class PromptChainVersion()

Specific version of a prompt chain with metadata.

Represents a particular version of a prompt chain including its configuration, description, and timestamps.

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "PromptChainVersion"

Create a PromptChainVersion instance from a dictionary.

Arguments:

Returns:

​

PromptChainRuleType

@dataclass
class PromptChainRuleType()

Individual rule for prompt chain deployment logic.

Defines a single rule that can be used to determine which version of a prompt chain should be deployed based on various conditions.

Attributes:

​

value

adding None here

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a PromptChainRuleType instance from a dictionary.

Arguments:

Returns:

​

PromptChainRuleGroupType

@dataclass
class PromptChainRuleGroupType()

Group of rules with a combinator for prompt chain deployment logic.

Allows grouping multiple rules together with logical operators (AND/OR) to create complex deployment conditions.

Attributes:

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a PromptChainRuleGroupType instance from a dictionary.

Arguments:

Returns:

​

PromptChainDeploymentRules

@dataclass
class PromptChainDeploymentRules()

Deployment rules for a specific prompt chain version.

Defines the conditions under which a particular version of a prompt chain should be deployed or used.

Attributes:

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a PromptChainDeploymentRules instance from a dictionary.

Arguments:

Returns:

​

VersionSpecificDeploymentConfig

@dataclass
class VersionSpecificDeploymentConfig()

Configuration for deploying a specific version.

Contains deployment configuration including rules, timestamps, and fallback information for a particular version.

Attributes:

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a VersionSpecificDeploymentConfig instance from a dictionary.

Arguments:

Returns:

​

PromptChainVersionsAndRules

@dataclass
class PromptChainVersionsAndRules()

Container for prompt chain versions and their deployment rules.

Aggregates all versions of a prompt chain along with their associated deployment rules and folder organization.

Attributes:

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a PromptChainVersionsAndRules instance from a dictionary.

Arguments:

Returns:

​

VersionAndRulesWithPromptChainId

@dataclass
class VersionAndRulesWithPromptChainId(PromptChainVersionsAndRules)

Extension of PromptChainVersionsAndRules that includes the prompt chain ID.

Provides the same functionality as PromptChainVersionsAndRules but also includes the prompt chain identifier for complete context.

Attributes:

Inherits all attributes from PromptChainVersionsAndRules

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a VersionAndRulesWithPromptChainId instance from a dictionary.

Arguments:

Returns:

​

MaximApiPromptChainResponse

@dataclass
class MaximApiPromptChainResponse()

Response wrapper for single prompt chain API calls.

Encapsulates the response from API calls that return information about a single prompt chain, including error handling.

Attributes:

​

from_dict

@staticmethod
def from_dict(data: Dict[str, Any]) -> "MaximApiPromptChainResponse"

Create a MaximApiPromptChainResponse instance from a dictionary.

Arguments:

Returns:

​

PromptChainWithId

@dataclass
class PromptChainWithId(PromptChainVersionsAndRules)

Prompt chain versions and rules with associated prompt chain ID.

Similar to VersionAndRulesWithPromptChainId but used in different contexts. Contains all version and rule information along with the prompt chain identifier.

Attributes:

Inherits all attributes from PromptChainVersionsAndRules

​

from_dict

@staticmethod
def from_dict(obj: Dict[str, Any])

Create a PromptChainWithId instance from a dictionary.

Arguments:

Returns:

​

VersionAndRulesWithPromptChainIdEncoder

class VersionAndRulesWithPromptChainIdEncoder(json.JSONEncoder)

Custom JSON encoder for VersionAndRulesWithPromptChainId objects.

Provides serialization support for VersionAndRulesWithPromptChainId instances by converting them to dictionaries.

​

default

def default(o)

Convert VersionAndRulesWithPromptChainId objects to dictionaries.

Arguments:

Returns:

​

MaximApiPromptChainsResponse

@dataclass
class MaximApiPromptChainsResponse()

Response wrapper for multiple prompt chains API calls.

Encapsulates the response from API calls that return information about multiple prompt chains, including error handling.

Attributes:

​

from_dict

@staticmethod
def from_dict(incoming_data: Dict[str, Any]) -> "MaximApiPromptChainsResponse"

Create a MaximApiPromptChainsResponse instance from a dictionary.

Arguments:

Returns: