Home > @google/generative-ai > FunctionDeclarationSchemaProperty
Schema is used to define the format of input/output data. Represents a select subset of an OpenAPI 3.0 schema object. More fields may be added in the future as needed.
Signature:
export interface FunctionDeclarationSchemaProperty | Property | Modifiers | Type | Description |
|---|---|---|---|
| description? | string | (Optional) Optional. The description of the property. | |
| enum? | string[] | (Optional) Optional. The enum of the property. | |
| example? | unknown | (Optional) Optional. The example of the property. | |
| format? | string | (Optional) Optional. The format of the property. | |
| items? | FunctionDeclarationSchema | (Optional) Optional. The items of the property. FunctionDeclarationSchema | |
| nullable? | boolean | (Optional) Optional. Whether the property is nullable. | |
| properties? | { [k: string]: FunctionDeclarationSchema; } | (Optional) Optional. Map of FunctionDeclarationSchema. | |
| required? | string[] | (Optional) Optional. Array of required property. | |
| type? | FunctionDeclarationSchemaType | (Optional) Optional. The type of the property. FunctionDeclarationSchemaType. |