Skip to main content

Interface: PlainFunctionParameter

core/completion.PlainFunctionParameter

Represents parameters to a FunctionDefinition.

This is a simplified version of the parameters field in ChatCompletionFunctions: https://platform.openai.com/docs/api-reference/chat/create#chat/create-parameters.

If you want to pass a field to FunctionParameters that isn't supported on this type, you can use a z.ZodObject schema instead.

Properties

required

required: boolean

Defined in

packages/ai-jsx/src/core/completion.tsx:101


description

Optional description: string

Defined in

packages/ai-jsx/src/core/completion.tsx:95


enum

Optional enum: string[]

The possible values this param can take.

Defined in

packages/ai-jsx/src/core/completion.tsx:100


type

Optional type: string

Defined in

packages/ai-jsx/src/core/completion.tsx:96