trace
¶
ASSISTANT_ROLE
module-attribute
¶
ASSISTANT_ROLE = MessageRole(ASSISTANT)
The assistant role with name not specified.
MaybeOneOrMany
module-attribute
¶
A type that can be either a single item, a sequence of items, or None.
OneOrMany
module-attribute
¶
A type that can be either a single item or a sequence of items.
SYSTEM_ROLE
module-attribute
¶
SYSTEM_ROLE = MessageRole(SYSTEM)
The system role with name not specified.
StrOrImg
module-attribute
¶
A type that can be either a string or an image.
String
module-attribute
¶
String = Union[StringFuture, str]
String is a type alias for StringFuture or str.
CallFuture
¶
CallFuture(
func: Callable,
*args: Any,
use_process: bool = False,
lazy_eval: bool = False,
**kwargs: Any
)
Bases: FutureValue
Represent a function call that may not be ready yet.
Parameters:
-
func
(Callable
) –The function to call.
-
*args
(Any
, default:()
) –The arguments of the function.
-
use_process
(bool
, default:False
) –Whether to use a process pool executor.
-
lazy_eval
(bool
, default:False
) –Whether to delay the start of the call until needed.
-
**kwargs
(Any
, default:{}
) –The keyword arguments of the function.
Source code in src/appl/core/types/futures.py
CmpStringFuture
¶
CmpStringFuture(
a: StringFuture,
b: StringFuture,
op: Callable[[str, str], bool],
)
Bases: FutureValue
Represent a comparison between a StringFuture and another value.
Source code in src/appl/core/types/futures.py
CompletionRequestEvent
¶
Bases: TraceEventBase
A class representing a completion request event.
CompletionResponseEvent
¶
ContentList
¶
Bases: BaseModel
Represent a list of contents containing text and images.
append
¶
append(content: StrOrImg) -> None
Append a content to the list.
If the last content is a string, it will be concatenated with the new content.
Source code in src/appl/core/types/content.py
extend
¶
get_contents
¶
get_contents() -> List[Dict[str, Any]]
Return the contents as a list of dictionaries.
Source code in src/appl/core/types/content.py
FunctionCallEvent
¶
FunctionReturnEvent
¶
Bases: TraceEventBase
A class representing a function return event.
FutureValue
¶
Bases: ABC
Represents a value that may not be ready yet.
GenerationInitEvent
¶
Bases: TraceEventBase
A class representing a generation init event.
GenerationResponseEvent
¶
Image
¶
Bases: BaseModel
Represent an image in the message.
See the guide for more information about the detail level.
Source code in src/appl/core/types/content.py
from_file
classmethod
¶
Construct an image prompt from an image file.
from_image
classmethod
¶
Construct an image prompt from a PIL ImageFile.
Source code in src/appl/core/types/content.py
MessageRole
¶
ResponseType
¶
The type of generation response.
UNFINISHED
class-attribute
instance-attribute
¶
The response is not finished.
StringFuture
¶
StringFuture(content: Any = '', set_value: bool = False)
Bases: FutureValue
, BaseModel
StringFuture is a string that may not be ready yet.
Source code in src/appl/core/types/futures.py
from_list
classmethod
¶
from_list(content: List[Any]) -> StringFuture
join
¶
join(iterable: Iterable[StringFuture]) -> StringFuture
Concatenate any number of strings.
The StringFuture whose method is called is inserted in between each given StringFuture. The result is returned as a new StringFuture.
Source code in src/appl/core/types/futures.py
materialized
¶
materialized() -> StringFuture
TraceEngineBase
¶
Bases: ABC
A base class for trace engines.
min_timestamp
cached
property
¶
min_timestamp: float
The minimum time stamp of the events in the trace.
trace_nodes
property
¶
The dictionary of trace nodes in the trace.
append
¶
append(event: TraceEventBase) -> None
TraceEventBase
¶
TraceNode
¶
Bases: BaseModel
The node of a trace tree containing information about trace events.
args
class-attribute
instance-attribute
¶
The arguments of the trace node.
children
class-attribute
instance-attribute
¶
children: List[TraceNode] = []
The children of the trace node.
parent
class-attribute
instance-attribute
¶
parent: Optional[TraceNode] = None
The parent of the trace node.
TracePrinterBase
¶
Bases: ABC
A base class for trace printers.
print
¶
print(
trace: TraceEngineBase,
meta_data: Optional[Configs] = None,
) -> Any
add_to_trace
¶
add_to_trace(event: TraceEventBase) -> None
find_in_cache
¶
find_in_cache(
name: str,
args: Dict,
cache: Optional[TraceEngineBase] = None,
) -> Any
Find a completion result in the cache.
Parameters:
-
name
(str
) –The name of the completion.
-
args
(Dict
) –The arguments of the completion.
-
cache
(Optional[TraceEngineBase]
, default:None
) –The cache to search in. Defaults to the global resume cache.
Returns:
-
Any
–The completion result if found, otherwise None.