Skip to content

@ralphschuler.ai function caller.types.AIFunction

Jump to bottom
github-actions edited this page Nov 26, 2023 · 1 revision

Module: types/AIFunction

Table of contents

Type Aliases

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

packages/ai-function-caller/src/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

packages/ai-function-caller/src/types/AIFunction.ts:63

AIFunctionCallArguments

Ƭ AIFunctionCallArguments: string

Represents the arguments passed in an AI function call.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:73

AIFunctionDescription

Ƭ AIFunctionDescription: string

Describes an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:9

AIFunctionExample

Ƭ AIFunctionExample: string

Represents an example usage of an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:78

AIFunctionName

Ƭ AIFunctionName: string

Represents the name of an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:4

AIFunctionParameter

Ƭ AIFunctionParameter: string | number | boolean

Represents a parameter value in an AI function call, which can be a string, number, or boolean.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:58

AIFunctionParameterName

Ƭ AIFunctionParameterName: string

Represents the name of a parameter in an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:14

AIFunctionParameters

Ƭ AIFunctionParameters: Object

Represents the parameters of an AI function, including their types and required status.

Type declaration

Name Type Description
properties { [key: AIFunctionParameterName]: AIFunctionProperty; } The properties of the parameters, keyed by the parameter name.
required AIFunctionParameterName[] An array of parameter names that are required.
type "object" The type of the parameters, typically an object.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:44

AIFunctionProperty

Ƭ AIFunctionProperty: Object

Represents a property of an AI function, including its type and description.

Type declaration

Name Type Description
description AIPropertyDescription The description of the property.
type AIPropertyType The type of the property.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:34

AIFunctionPropertyName

Ƭ AIFunctionPropertyName: string

Represents the name of a property in an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:24

AIPropertyDescription

Ƭ AIPropertyDescription: string

Describes a property in an AI function.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:29

AIPropertyType

Ƭ AIPropertyType: "string" | "integer" | "boolean" | "object"

Enumerates the possible types for AI function properties.

Defined in

packages/ai-function-caller/src/types/AIFunction.ts:19

Typescript Libraries

Modules

Namespaces

Clone this wiki locally