@ralphschuler.ai function caller.index.<internal>.OpenAI.Chat.Completions.ChatCompletionCreateParams.Function

Interface: Function

Completions.ChatCompletionCreateParams.Function

Table of contents

Properties

• description
• name
• parameters

Properties

description

• Optional description: string

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

Defined in

node_modules/openai/resources/chat/completions.d.ts:614

---

name

• 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.

Defined in

node_modules/openai/resources/chat/completions.d.ts:598

---

parameters

• 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": {}}.

Defined in

node_modules/openai/resources/chat/completions.d.ts:609