OpenApiFunctionDefinition interface
The input definition information for an openapi function.
Properties
| auth | Open API authentication details |
| default_params | 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 function definitions used by OpenApi tool |
| 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: OpenApiAuthDetailsUnionProperty Value
default_params
List of OpenAPI spec parameters that will use user-provided defaults
default_params?: 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?: stringProperty Value
string
functions
List of function definitions used by OpenApi tool
functions?: { description?: string, name: string, parameters: any }[]Property Value
{ description?: string, name: string, parameters: any }[]
name
The name of the function to be called.
name: stringProperty Value
string
spec
The openapi function shape, described as a JSON Schema object.
spec: anyProperty Value
any
