Class AIFunction<ReturnType, Schema, Args>`Abstract`

Type Parameters

ReturnType = unknown
Schema extends JsonSchema = typeof DefaultJsonSchema
Args = FromSchema<Schema>

Hierarchy (View Summary)

AITool
- AIFunction

Index

Constructors

Properties

additionalProperties description name schema

Methods

invoke invokeCore

Constructors

`Protected`constructor

new AIFunction<
    ReturnType = unknown,
    Schema extends JsonSchema = {},
    Args = FromSchema<Schema>,
>(): AIFunction<ReturnType, Schema, Args>
Type Parameters
- ReturnType = unknown
- Schema extends JsonSchema = {}
- Args = FromSchema<Schema>
Returns AIFunction<ReturnType, Schema, Args>
Inherited from AITool.constructor
- Defined in src/AI/dist/index.d.ts:9

Properties

additionalProperties

additionalProperties: AdditionalProperties

description

description: string

name

name: string

schema

schema: undefined | Schema

Methods

invoke

invoke(args?: AIFunctionArguments<Schema, Args>): Promise<ReturnType>
Parameters
- Optionalargs: AIFunctionArguments<Schema, Args>
Returns Promise<ReturnType>
- Defined in src/AI/dist/index.d.ts:396

`Protected` `Abstract`invokeCore

invokeCore(args?: AIFunctionArguments<Schema, Args>): Promise<ReturnType>
Parameters
- Optionalargs: AIFunctionArguments<Schema, Args>
Returns Promise<ReturnType>
- Defined in src/AI/dist/index.d.ts:397