@ralphschuler.ai function caller

Module: @ralphschuler/ai-function-caller

Table of contents

Enumerations

• MessageRole

Classes

• AIFunctionCaller

Type Aliases

• AIFunction
• AIFunctionCall
• Message
• MessageContent
• MessageSender

Type Aliases

AIFunction

Ƭ AIFunction<AiFunctionCallResponse>: Object

Represents an AI function, including its name, description, parameters, and the method to execute it.

Type parameters

Name	Description
AiFunctionCallResponse	The expected response type from the AI function call.

Type declaration

Name	Type	Description
description	AIFunctionDescription	A description of the AI function.
example?	AIFunctionExample	An optional example of how the AI function can be used.
method	(args: AIFunctionCallArguments) => Promise<AiFunctionCallResponse>	The method to execute the AI function.
name	AIFunctionName	The name of the AI function.
parameters	AIFunctionParameters	The parameters required by the AI function.

Defined in

types/AIFunction.ts:84

---

AIFunctionCall

Ƭ AIFunctionCall: Object

Represents a call to an AI function, including the function name and arguments.

Type declaration

Name	Type	Description
arguments	AIFunctionCallArguments	The arguments passed to the AI function.
name	AIFunctionName	The name of the AI function being called.

Defined in

types/AIFunction.ts:63

---

Message

Ƭ Message: Object

Represents a message in the system.

Type declaration

Name	Type	Description
content	MessageContent | null	The content of the message, which can be null.
function_call?	AIFunctionCall	Optional AI function call associated with the message.
name	MessageSender	The name of the message sender.
role	MessageRole	The role of the message sender.

Defined in

types/Message.ts:6

---

MessageContent

Ƭ MessageContent: string

Defines the content of a message, represented as a string.

Defined in

types/Message.ts:20

---

MessageSender

Ƭ MessageSender: string

Represents the sender of a message, identified by a string.

Defined in

types/Message.ts:39