PlanAI
Contents:
Installation
Usage
Prompts
Provenance in PlanAI
CLI
API Reference
PlanAI
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
_
__init__() (planai.CachedTaskWorker method)
(planai.ChatTaskWorker method)
(planai.Graph method)
(planai.LLMInterface method)
(planai.LLMTaskWorker method)
(planai.PydanticDictWrapper method)
(planai.TaskWorker method)
(planai.testing.InvokeTaskWorker method)
(planai.testing.MockCache method)
(planai.testing.MockLLM method)
(planai.testing.MockLLMResponse method)
(planai.testing.TestTaskContext method)
(planai.Tool method)
_consumers (planai.TaskWorker attribute)
_end_time (planai.Task attribute)
_graph (planai.TaskWorker attribute)
_id (planai.TaskWorker attribute)
_input_provenance (planai.Task attribute)
_instance_id (planai.TaskWorker attribute)
_local (planai.TaskWorker attribute)
_private_state (planai.Task attribute)
_provenance (planai.Task attribute)
_retry_count (planai.Task attribute)
_start_time (planai.Task attribute)
A
abort_work() (planai.Graph method)
accepted_mime_types (planai.UserInputRequest attribute)
add_input_provenance() (in module planai.testing)
add_private_state() (planai.Task method)
add_work() (planai.Graph method)
(planai.TaskWorker method)
add_worker() (planai.Graph method)
add_workers() (planai.Graph method)
assert_published_task_count() (planai.testing.InvokeTaskWorker method)
,
[1]
assert_published_task_types() (planai.testing.InvokeTaskWorker method)
,
[1]
B
BaseLLMTaskWorker (class in planai)
C
cache_dir (planai.CachedTaskWorker attribute)
cache_size_limit (planai.CachedTaskWorker attribute)
CachedLLMTaskWorker (class in planai)
CachedTaskWorker (class in planai)
chat() (planai.LLMInterface method)
ChatMessage (class in planai)
ChatTask (class in planai)
ChatTaskWorker (class in planai)
check() (planai.integrations.SerperGoogleSearchTool static method)
clear_stats() (planai.testing.MockCache method)
client (planai.LLMInterface attribute)
completed() (planai.TaskWorker method)
compute_worker_distances() (planai.Graph method)
ConsolidatedPages (class in planai.patterns)
consume_work() (planai.ChatTaskWorker method)
(planai.JoinedTaskWorker method)
(planai.LLMTaskWorker method)
(planai.TaskWorker method)
consume_work_joined() (planai.JoinedTaskWorker method)
content (planai.ChatMessage attribute)
copy_input_provenance() (planai.Task method)
copy_provenance() (planai.Task method)
copy_public() (planai.Task method)
create_parser() (in module planai.cli)
create_planning_worker() (in module planai.patterns)
create_search_fetch_worker() (in module planai.patterns)
D
debug_dir (planai.LLMTaskWorker attribute)
debug_mode (planai.LLMTaskWorker attribute)
dependencies (planai.Graph attribute)
,
[1]
description (planai.Tool attribute)
dict() (planai.PydanticDictWrapper method)
disk_cache (planai.LLMInterface attribute)
display_terminal_status() (planai.Graph method)
E
enable_trace (planai.JoinedTaskWorker attribute)
execute() (planai.Graph method)
(planai.Tool method)
extra_cache_key() (planai.CachedTaskWorker method)
extra_validation() (planai.LLMTaskWorker method)
extract_markdown() (planai.integrations.WebBrowser static method)
F
finalize() (planai.Graph method)
FinalPlan (class in planai.patterns)
find_input_task() (planai.Task method)
find_input_tasks() (planai.Task method)
format_prompt() (planai.LLMTaskWorker method)
func (planai.Tool attribute)
G
generate_full_prompt() (planai.LLMInterface method)
generate_pydantic() (planai.LLMInterface method)
get() (planai.testing.MockCache method)
get_dispatcher() (planai.Graph method)
get_entry_workers() (planai.Graph method)
get_exit_worker() (planai.Graph method)
get_format_instructions() (planai.LLMInterface static method)
get_full_prompt() (planai.LLMTaskWorker method)
get_markdown_from_page() (planai.integrations.WebBrowser static method)
get_metadata() (planai.TaskWorker method)
get_next_provenance() (planai.TaskWorker method)
get_output_tasks() (planai.Graph method)
get_page_content() (planai.integrations.WebBrowser static method)
get_private_state() (planai.Task method)
get_state() (planai.TaskWorker method)
get_task_class() (planai.JoinedTaskWorker method)
(planai.LLMTaskWorker method)
(planai.TaskWorker method)
get_task_classes() (planai.TaskWorker method)
get_worker_by_input_type() (planai.Graph method)
get_worker_by_output_type() (planai.Graph method)
get_worker_state() (planai.TaskWorker method)
Graph (class in planai)
I
increment_retry_count() (planai.Task method)
init() (planai.TaskWorker method)
init_workers() (planai.Graph method)
InitialTaskWorker (class in planai)
,
[1]
inject_input() (planai.Task method)
inject_mock_cache() (in module planai.testing)
instance (planai.PydanticDictWrapper property)
instruction (planai.UserInputRequest attribute)
invoke() (planai.testing.InvokeTaskWorker method)
,
[1]
invoke_joined() (planai.testing.InvokeTaskWorker method)
InvokeTaskWorker (class in planai.testing)
is_type() (planai.Task method)
J
join_type (planai.JoinedTaskWorker attribute)
JoinedTaskWorker (class in planai)
json() (planai.PydanticDictWrapper method)
L
list() (planai.LLMInterface method)
llm (planai.BaseLLMTaskWorker attribute)
llm_from_config() (in module planai)
llm_input_type (planai.LLMTaskWorker attribute)
llm_output_type (planai.LLMTaskWorker attribute)
LLMInterface (class in planai)
LLMTaskWorker (class in planai)
lock (planai.TaskWorker property)
log_dir (planai.LLMInterface attribute)
M
main() (in module planai.cli)
max_retries (planai.LLMInterface attribute)
messages (planai.ChatTask attribute)
MockCache (class in planai.testing)
MockLLM (class in planai.testing)
MockLLMResponse (class in planai.testing)
model (planai.PydanticDictWrapper property)
model_dump_xml() (planai.Task method)
model_name (planai.LLMInterface attribute)
module
planai
planai.cli
planai.integrations
planai.patterns
planai.testing
N
name (planai.Graph attribute)
,
[1]
(planai.Task property)
(planai.TaskWorker property)
(planai.Tool attribute)
next() (planai.TaskWorker method)
notify() (planai.JoinedTaskWorker method)
(planai.TaskWorker method)
notify_status() (planai.TaskWorker method)
num_retries (planai.TaskWorker attribute)
,
[1]
O
output_types (planai.ChatTaskWorker attribute)
(planai.TaskWorker attribute)
,
[1]
P
parameters (planai.Tool attribute)
parse_comma_separated_list() (in module planai.cli)
planai
module
planai.cli
module
planai.integrations
module
planai.patterns
module
planai.testing
module
PlanRequest (class in planai.patterns)
post_consume_work() (planai.CachedTaskWorker method)
post_process() (planai.LLMTaskWorker method)
pre_consume_work() (planai.CachedTaskWorker method)
pre_process() (planai.LLMTaskWorker method)
prefix() (planai.Task method)
prefix_for_input_task() (planai.Task method)
prepare() (planai.Graph method)
previous_input_task() (planai.Task method)
print() (planai.Graph method)
(planai.TaskWorker method)
prompt (planai.LLMTaskWorker attribute)
provenance (planai.UserInputRequest attribute)
publish_work() (planai.TaskWorker method)
PydanticDictWrapper (class in planai)
R
register_consumer() (planai.TaskWorker method)
register_dispatcher() (planai.Graph method)
remove_state() (planai.TaskWorker method)
request_user_input() (planai.TaskWorker method)
requires_thinking (planai.LLMInterface attribute)
reset() (planai.testing.TestTaskContext method)
respond() (planai.UserInputRequest method)
retry_count (planai.Task property)
retry_delay (planai.LLMInterface attribute)
role (planai.ChatMessage attribute)
run() (planai.Graph method)
S
search_internet() (planai.integrations.SerperGoogleSearchTool static method)
SearchQuery (class in planai.patterns)
SearchResult (class in planai.patterns)
SerperGoogleSearchTool (class in planai.integrations)
set() (planai.testing.MockCache method)
set_dependency() (planai.Graph method)
set_entry() (planai.Graph method)
set_exit() (planai.Graph method)
set_graph() (planai.TaskWorker method)
set_max_parallel_tasks() (planai.Graph method)
set_sink() (planai.Graph method)
set_user_request_callback() (planai.Graph method)
shutdown() (planai.Graph method)
sink() (planai.TaskWorker method)
strict (planai.Graph attribute)
,
[1]
SubGraphWorker() (in module planai)
support_json_mode (planai.LLMInterface attribute)
support_structured_outputs (planai.LLMInterface attribute)
support_system_prompt (planai.LLMInterface attribute)
system_prompt (planai.BaseLLMTaskWorker attribute)
(planai.ChatTaskWorker attribute)
T
Task (class in planai)
task_id (planai.UserInputRequest attribute)
TaskWorker (class in planai)
temperature (planai.LLMTaskWorker attribute)
TestTaskContext (class in planai.testing)
timeout (planai.LLMInterface attribute)
to_dict() (planai.Tool method)
token_usage (planai.LLMInterface attribute)
Tool (class in planai)
tool() (in module planai)
tools (planai.BaseLLMTaskWorker attribute)
trace() (planai.Graph method)
(planai.TaskWorker method)
U
unregister_output_type() (in module planai.testing)
unwatch() (planai.Graph method)
(planai.TaskWorker method)
use_xml (planai.LLMTaskWorker attribute)
UserInputRequest (class in planai)
V
validate_graph() (planai.Graph method)
validate_task() (planai.TaskWorker method)
W
wait_on_user_request() (planai.Graph method)
watch() (planai.Graph method)
(planai.TaskWorker method)
WebBrowser (class in planai.integrations)
work_buffer_context() (planai.TaskWorker method)
workers (planai.Graph attribute)
,
[1]