FunctionInfo

Type definition for function metadata

The FunctionInfo type contains metadata about a registered function in the III Engine.

Type Definition

TypeScript

type FunctionInfo = {
  function_id: string
  description?: string
  request_format?: RegisterFunctionFormat
  response_format?: RegisterFunctionFormat
  metadata?: Record<string, unknown>
}

Python

class FunctionInfo(BaseModel):
    function_id: str
    description: str | None = None
    request_format: RegisterFunctionFormat | None = None
    response_format: RegisterFunctionFormat | None = None
    metadata: dict[str, Any] | None = None

Rust

pub struct FunctionInfo {
    pub function_id: String,
    pub description: Option<String>,
    pub request_format: Option<Value>,
    pub response_format: Option<Value>,
    pub metadata: Option<Value>,
}

Fields

function_id · string · required

The unique identifier (path) of the function. Use :: for namespacing (e.g., external::my_lambda).

description · string

Human-readable description of what the function does.

request_format · RegisterFunctionFormat

Schema definition for the function’s input parameters.

response_format · RegisterFunctionFormat

Schema definition for the function’s return value.

metadata · object

Additional custom metadata associated with the function.

Usage

FunctionInfo is returned by:

• listFunctions() - Get all registered functions
• onFunctionsAvailable() callback - Receive function list updates

TypeScript

const functions = await iii.listFunctions()

functions.forEach((func: FunctionInfo) => {
  console.log(`Function: ${func.function_id}`)
  console.log(`Description: ${func.description}`)
})

Python

functions = await iii.list_functions()

for func in functions:
    print(f"Function: {func.function_id}")
    print(f"Description: {func.description}")

Rust

let functions = iii.list_functions().await?;

for func in functions {
    println!("Function: {}", func.function_id);
    if let Some(desc) = &func.description {
        println!("Description: {}", desc);
    }
}

Related Types

• RegisterFunctionFormat - Schema definition for parameters
• Trigger Configuration - Configure triggers for functions