Skip to main content
Version: 2.0

aixplain.v2.utility

Utility resource module for managing custom Python code utilities.

UtilitySearchParams Objects​

class UtilitySearchParams(BaseSearchParams)

[view_source]

Parameters for listing utilities.

Attributes:

  • function - Function: The function of the utility (should be UTILITIES).
  • status - str: The status of the utility.
  • query - str: Search query for utilities.
  • ownership - Tuple[OwnershipType, List[OwnershipType]]: Ownership filter.

UtilityRunParams Objects​

class UtilityRunParams(BaseRunParams)

[view_source]

Parameters for running utilities.

Attributes:

  • data - str: The data to run the utility on.

Utility Objects​

@dataclass_json

@dataclass(repr=False)
class Utility(BaseResource, SearchResourceMixin[UtilitySearchParams,
                                                "Utility"],
              GetResourceMixin[BaseGetParams, "Utility"],
              DeleteResourceMixin[BaseDeleteParams, "Utility"],
              RunnableResourceMixin[UtilityRunParams, Result])

[view_source]

Resource for utilities.

Utilities are standalone assets that can be created and managed independently of models. They represent custom functions that can be executed on the platform.

__post_init__​

def __post_init__() -> None

[view_source]

Parse code and validate description for new utility instances.

build_save_payload​

def build_save_payload(**kwargs: Any) -> dict

[view_source]

Build the payload for the save action.

get​

@classmethod
def get(cls: type["Utility"], id: str,
        **kwargs: Unpack[BaseGetParams]) -> "Utility"

[view_source]

Get a utility by ID.

Arguments:

  • id - The utility ID.
  • **kwargs - Additional parameters for the get request.

Returns:

The retrieved Utility instance.

run​

@classmethod
def run(cls: type["Utility"], **kwargs: Unpack[UtilityRunParams]) -> Result

[view_source]

Run the utility with provided parameters.

Arguments:

  • **kwargs - Run parameters including data to process.

Returns:

Result of the utility execution.

@classmethod
def search(cls: type["Utility"],
           query: Optional[str] = None,
           **kwargs: Unpack[UtilitySearchParams]) -> "Page[Utility]"

[view_source]

Search utilities with optional query and filtering.

Arguments:

  • query - Optional search query string
  • **kwargs - Additional search parameters (function, status, etc.)

Returns:

Page of utilities matching the search criteria