FunctionDeclaration class final
Structured representation of a function declaration as defined by the
OpenAPI 3.03 specification. Included
in this declaration are the function name and parameters. This
FunctionDeclaration is a representation of a block of code that can be used
as a Tool by the model and executed by the client.
- Inheritance
-
- Object
- ProtoMessage
- FunctionDeclaration
Constructors
- FunctionDeclaration({required String name, required String description, Schema? parameters, Value? parametersJsonSchema, Schema? response, Value? responseJsonSchema, FunctionDeclaration_Behavior behavior = FunctionDeclaration_Behavior.$default})
- FunctionDeclaration.fromJson(Object? j)
-
factory
Properties
- behavior → FunctionDeclaration_Behavior
-
Optional. Specifies the function Behavior.
Currently only supported by the BidiGenerateContent method.
final
- description → String
-
Required. A brief description of the function.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- name → String
-
Required. The name of the function.
Must be a-z, A-Z, 0-9, or contain underscores, colons, dots, and dashes,
with a maximum length of 64.
final
- parameters → Schema?
-
Optional. Describes the parameters to this function. Reflects the Open
API 3.03 Parameter Object string Key: the name of the parameter. Parameter
names are case sensitive. Schema Value: the Schema defining the type used
for the parameter.
final
- parametersJsonSchema → Value?
-
Optional. Describes the parameters to the function in JSON Schema format.
The schema must describe an object where the properties are the parameters
to the function. For example:
final
- qualifiedName → String
-
The fully qualified name of this message, i.e.,
google.protobuf.Durationorgoogle.rpc.ErrorInfo.finalinherited - response → Schema?
-
Optional. Describes the output from this function in JSON Schema format.
Reflects the Open API 3.03 Response Object. The Schema defines the type
used for the response value of the function.
final
- responseJsonSchema → Value?
-
Optional. Describes the output from this function in JSON Schema format.
The value specified by the schema is the response value of the function.
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
-
toJson(
) → Object -
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- fullyQualifiedName → const String