Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.upsonic.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Specify the docstring format for parameter description extraction.

​
Usage

from upsonic.tools import tool

@tool(docstring_format='google')
def process_data(input_data: str, format_type: str) -> str:
    """
    Process data with specified format.

    Args:
        input_data: The data to process
        format_type: Format type for processing

    Returns:
        Processed data result
    """
    return f"Processed {input_data} as {format_type}"

​
Parameters

  • docstring_format (str): Format type - ‘google’, ‘numpy’, ‘sphinx’, or ‘auto’ (default: ‘auto’)