base

base

AI Agent

Base classes for PraisonAI Agent tools.

This module provides the foundation for creating tools that can be used by agents. External developers can create plugins by subclassing BaseTool.

Usage:

from praisonaiagents import BaseTool

class MyTool(BaseTool):
    name = "my_tool"
    description = "Does something useful"

    def run(self, query: str) -> str:
        return f"Result for {query}"

Functions

resolve_model_output()

Return a tool result’s own compact, model-facing view, or None.

multimodal_content()

Convenience factory for building a multimodal ToolResult.

text_part()

Build a text content part.

image_part()

Build an image content part from raw bytes/base64 or a URL/data URI.

file_part()

Build a generic file content part from raw bytes/base64 or a URL.

validate_tool()

Validate any tool-like object.

validate_tool_schema_consistency()

Validate a list of tools for schema consistency with OpenAI format.

get_sorted_tool_schemas()

Get tool schemas sorted by function name for deterministic ordering.

Guide

Reference

base • AI Agent SDK

Import

Classes

ToolValidationError

ToolResult

BaseTool

Functions

resolve_model_output()

multimodal_content()

text_part()

image_part()

file_part()

validate_tool()

validate_tool_schema_consistency()

get_sorted_tool_schemas()

​base

​Import

​Classes

ToolValidationError

ToolResult

BaseTool

​Functions

resolve_model_output()

multimodal_content()

text_part()

image_part()

file_part()

validate_tool()

validate_tool_schema_consistency()

get_sorted_tool_schemas()

base

Import

Classes

Functions