OpenAIFunctionProperty class
This class is used to represent an OpenAI function property.
Constructors
-
OpenAIFunctionProperty({required String name, required Map<
String, dynamic> typeMap, bool isRequired = false, List<String> ? requiredProperties}) -
This class is used to represent an OpenAI function property.
const
- OpenAIFunctionProperty.array({required String name, String? description, bool isRequired = false, required OpenAIFunctionProperty items})
-
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with an array (List) type.
factory
- OpenAIFunctionProperty.boolean({required String name, String? description, bool isRequired = false})
-
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with a boolean type.
factory
- OpenAIFunctionProperty.integer({required String name, String? description, bool isRequired = false})
-
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with an integer type.
factory
- OpenAIFunctionProperty.number({required String name, String? description, bool isRequired = false})
-
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with a number type.
factory
-
OpenAIFunctionProperty.object({required String name, String? description, required Iterable<
OpenAIFunctionProperty> properties, bool isRequired = false}) -
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with an object (Map) type.
factory
- OpenAIFunctionProperty.primitive({required String name, String? description, bool isRequired = false, required String type, List? enumValues})
-
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with a primitive type.
factory
-
OpenAIFunctionProperty.string({required String name, String? description, bool isRequired = false, List<
String> ? enumValues}) -
This class is used to represent an OpenAI function property.
This a factory constructor that allows you to create a new function property with a string type.
factory
Properties
- hashCode → int
-
The hash code for this object.
no setteroverride
- isRequired → bool
-
Weither the property is required.
final
- name → String
-
The name of the property.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> - This method is used to convert a OpenAIFunctionProperty object to a Map<String, dynamic> object.
-
toString(
) → String -
A string representation of this object.
inherited
-
typeEntry(
) → MapEntry< String, Map< String, dynamic> > - The type entry of the property.
-
typeMap(
) → Map< String, dynamic> - The type map of the property.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- functionTypeArray → const String
- An array (List) type.
- functionTypeBoolean → const String
- A boolean type.
- functionTypeInteger → const String
- an integer type.
- functionTypeNumber → const String
- A number type.
- functionTypeObject → const String
- An object (Map) type.
- functionTypeString → const String
- A string type.