README.md

function-gpt

function-gpt

Table of contents

Classes

• FunctionCallingProvider

Functions

• gptFunction
• gptObjectField
• gptString
• gptNumber
• gptBoolean
• gptObject
• gptEnum
• gptArray

Functions

gptFunction

▸ gptFunction(description, inputType): (target: object, propertyKey: string, descriptor: PropertyDescriptor) => void

Use this decorator on a method within a FunctionCallingProvider subclass to enable it for function-calling.

Parameters

Name	Type	Description
description	string	A description of the function.
inputType	() => unknown	Input for the function should be an object instance of a custom class. This parameter specifies the class of the object.

Returns

fn

▸ (target, propertyKey, descriptor): void

Parameters

Name	Type
target	object
propertyKey	string
descriptor	PropertyDescriptor

Returns

void

See

gptObjectField

Defined in

src/decorators.ts:20

---

gptObjectField

▸ gptObjectField(type, description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
type	"string" | "number" | "boolean" | { enum: string[] } | ["string" | "number" | "boolean" | { enum: string[] } | () => unknown] | () => unknown	undefined	Type of the field. Use 'string', 'number', 'boolean' for primitive types. Use ['string'], ['number'], ['boolean'] for arrays of primitive types. Use a ClassName for custom types. Use [ClassName] for arrays of custom types.
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:61

---

gptString

▸ gptString(description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a string property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:158

---

gptNumber

▸ gptNumber(description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a number property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:168

---

gptBoolean

▸ gptBoolean(description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a boolean property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:178

---

gptObject

▸ gptObject(type, description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a custom class property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
type	() => unknown	undefined	Type of the field.
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:189

---

gptEnum

▸ gptEnum(values, description, optional?): (target: object, propertyKey: string) => void

Use this decorator on a custom class property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
values	string[]	undefined	Possible values of the enum.
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:204

---

gptArray

▸ gptArray(type, description, optional?): (target: object, propertyKey: string) => void

Use this decorator on an array of strings property within a custom class to include it as a parameter for function-calling.

Parameters

Name	Type	Default value	Description
type	"string" | "number" | "boolean" | { enum: string[] } | () => unknown	undefined	-
description	string	undefined	Description of the field.
optional	boolean	false	Whether the field is optional. Default to false.

Returns

fn

▸ (target, propertyKey): void

Parameters

Name	Type
target	object
propertyKey	string

Returns

void

Defined in

src/decorators.ts:218