Skip to main content
Module

x/openai/resources/shared.ts>FunctionDefinition

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface FunctionDefinition
import { type FunctionDefinition } from "https://deno.land/x/openai@v4.21.0/resources/shared.ts";

Properties

name: string

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

parameters: FunctionParameters

The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

To describe a function that accepts no parameters, provide the value {"type": "object", "properties": {}}.

optional
description: string

A description of what the function does, used by the model to choose when and how to call the function.