Share via


OpenApiFunctionDefinition interface

The input definition information for an openapi function.

Properties

auth

Open API authentication details

defaultParams

List of OpenAPI spec parameters that will use user-provided defaults

description

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

functions

List of functions returned in response

name

The name of the function to be called.

spec

The openapi function shape, described as a JSON Schema object.

Property Details

auth

Open API authentication details

auth: OpenApiAuthDetails

Property Value

defaultParams

List of OpenAPI spec parameters that will use user-provided defaults

defaultParams?: string[]

Property Value

string[]

description

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

description?: string

Property Value

string

functions

List of functions returned in response

functions?: FunctionDefinition[]

Property Value

name

The name of the function to be called.

name: string

Property Value

string

spec

The openapi function shape, described as a JSON Schema object.

spec: unknown

Property Value

unknown