Home > llm-ops > FunctionInterface
FunctionInterface interface
Signature:
typescript
export interface FunctionInterface
export interface FunctionInterface
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
description? | string | (Optional) A description of what the function does, used by the model to choose when and how to call the function. | |
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 | Record<string, unknown> | The parameters the functions accepts, described as a JSON Schema object. See the [guide](https://platform.openai.com/docs/guides/gpt/function-calling) for examples, and the [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for documentation about the format. To describe a function that accepts no parameters, provide the value |