Skip to main content
Version: 2.0

aixplain.v2.mixins

Mixins for v2 API classes.

ParameterInput Objects​

class ParameterInput(TypedDict)

[view_source]

TypedDict for individual parameter input configuration.

ParameterDefinition Objects​

class ParameterDefinition(TypedDict)

[view_source]

TypedDict for parameter definition structure.

ToolDict Objects​

class ToolDict(TypedDict)

[view_source]

TypedDict defining the expected structure for tool serialization.

This provides type safety and documentation for the as_tool() method return value.

ToolableMixin Objects​

class ToolableMixin(ABC)

[view_source]

Mixin that enforces the as_tool() interface for classes that can be used as tools.

Any class that inherits from this mixin must implement the as_tool() method, which serializes the object into a format suitable for agent tool usage.

as_tool​

@abstractmethod
def as_tool() -> ToolDict

[view_source]

Serialize this object as a tool for agent creation.

This method converts the object into a dictionary format that can be used as a tool when creating agents. The format is strictly typed using ToolDict.

Returns:

  • ToolDict - A typed dictionary representing this object as a tool with:
    • id: The tool's unique identifier
    • name: The tool's display name
    • description: The tool's description
    • supplier: The supplier code (e.g., "aixplain")
    • parameters: Optional list of parameter configurations
    • function: The tool's function type (e.g., "utilities")
    • type: The tool type (e.g., "model")
    • version: The tool's version as a string
    • assetId: The tool's asset ID (usually same as id)

Raises:

  • NotImplementedError - If the subclass doesn't implement this method