AxFunction

TypeScript

type AxFunction = object;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L438

Properties

componentId?

TypeScript

optional componentId: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L443

description

TypeScript

description: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L442

execution?

TypeScript

optional execution: "blocking" | "background";

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L440

Background tools permit independent model work while they execute.

func

TypeScript

func: AxFunctionHandler;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L462

name

TypeScript

name: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L441

namespace?

TypeScript

optional namespace: string;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L446

parameters?

TypeScript

optional parameters: AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L444

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/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L448

Native protocol identity retained independently of provider tool names.

returns?

TypeScript

optional returns: AxFunctionJSONSchema;

Defined in: https://github.com/ax-llm/ax/blob/3d5aa8dac28a2637e4150f022dcd02e6fc3309f0/src/ax/ai/types.ts#L445