ToolClientFunctionResponse class
Constructors
-
ToolClientFunctionResponse({Input<String?>? additionalProperties, Input<String?>? anyOf, Input<String?>? default_, Input<String?>? defs, Input<String?>? description, Input<List<String>?>? enums, Input<String?>? items, Input<int?>? maxItems, Input<double?>? maximum, Input<int?>? minItems, Input<double?>? minimum, Input<bool?>? nullable, Input<String?>? prefixItems, Input<String?>? properties, Input<String?>? ref, Input<List<String>?>? requireds, Input<String?>? title, required Input<String> type, Input<bool?>? uniqueItems})
-
Creates a new ToolClientFunctionResponse.
additionalProperties Defines the schema for additional properties allowed in an object.
anyOf The instance value should be valid against at least one of the schemas in this list.
default_ Default value of the data. Represents a dynamically typed value
defs A map of definitions for use by ref. Only allowed at the root of the schema.
description The description of the data.
enums Possible values of the element of primitive type with enum format.
items Schema of the elements of Type.ARRAY.
maxItems Maximum number of the elements for Type.ARRAY. (int64 format)
maximum Maximum value for Type.INTEGER and Type.NUMBER.
minItems Minimum number of the elements for Type.ARRAY. (int64 format)
minimum Minimum value for Type.INTEGER and Type.NUMBER.
nullable Indicates if the value may be null.
prefixItems Schemas of initial elements of Type.ARRAY.
properties Properties of Type.OBJECT.
ref Allows indirect references between schema nodes. The value should be a
requireds Required properties of Type.OBJECT.
title The title of the schema.
type The type of the data.
uniqueItems Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
const
-
ToolClientFunctionResponse.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
additionalProperties
→ Input<String?>?
-
Defines the schema for additional properties allowed in an object.
The value must be a valid JSON string representing the Schema object.
(Note: OpenAPI also allows a boolean, this definition expects a Schema JSON).
final
-
anyOf
→ Input<String?>?
-
The instance value should be valid against at least one of the schemas in this list.
final
-
default_
→ Input<String?>?
-
Default value of the data. Represents a dynamically typed value
which can be either null, a number, a string, a boolean, a struct,
or a list of values. The provided default value must be compatible
with the defined 'type' and other schema constraints.
final
-
defs
→ Input<String?>?
-
A map of definitions for use by ref. Only allowed at the root of the schema.
final
-
description
→ Input<String?>?
-
The description of the data.
final
-
enums
→ Input<List<String>?>?
-
Possible values of the element of primitive type with enum format.
Examples:
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
items
→ Input<String?>?
-
Schema of the elements of Type.ARRAY.
final
-
maximum
→ Input<double?>?
-
Maximum value for Type.INTEGER and Type.NUMBER.
final
-
maxItems
→ Input<int?>?
-
Maximum number of the elements for Type.ARRAY. (int64 format)
final
-
minimum
→ Input<double?>?
-
Minimum value for Type.INTEGER and Type.NUMBER.
final
-
minItems
→ Input<int?>?
-
Minimum number of the elements for Type.ARRAY. (int64 format)
final
-
nullable
→ Input<bool?>?
-
Indicates if the value may be null.
final
-
prefixItems
→ Input<String?>?
-
Schemas of initial elements of Type.ARRAY.
final
-
properties
→ Input<String?>?
-
Properties of Type.OBJECT.
final
-
ref
→ Input<String?>?
-
Allows indirect references between schema nodes. The value should be a
valid reference to a child of the root
defs.
For example, the following schema defines a reference to a schema node
named "Pet":
type: object
properties:
pet:
ref: #/defs/Pet
defs:
Pet:
type: object
properties:
name:
type: string
The value of the "pet" property is a reference to the schema node
named "Pet".
See details in
https://json-schema.org/understanding-json-schema/structuring.
final
-
requireds
→ Input<List<String>?>?
-
Required properties of Type.OBJECT.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
title
→ Input<String?>?
-
The title of the schema.
final
-
type
→ Input<String>
-
The type of the data.
Possible values:
STRING
INTEGER
NUMBER
BOOLEAN
OBJECT
ARRAY
final
-
uniqueItems
→ Input<bool?>?
-
Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
final
