AxFunction

TypeScript

type AxFunction = object;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L338

Properties

componentId?

TypeScript

optional componentId: string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L341

description

TypeScript

description: string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L340

func

TypeScript

func: AxFunctionHandler;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L360

name

TypeScript

name: string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L339

namespace?

TypeScript

optional namespace: string;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L344

parameters?

TypeScript

optional parameters: AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L342

protocol?

TypeScript

optional protocol: 
  | {
  annotations?: Record<string, unknown>;
  kind: "mcp";
  meta?: Record<string, unknown>;
  name: string;
  namespace: string;
}
  | {
  kind: "ucp";
  meta?: Record<string, unknown>;
  name: string;
  namespace: string;
};

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L346

Native protocol identity retained independently of provider tool names.

returns?

TypeScript

optional returns: AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/e4219a44b7581a55a40d9dd62d2c281062ff078d/src/ax/ai/types.ts#L343