public sealed class FunctionDeclaration : IMessage<FunctionDeclaration>, IEquatable<FunctionDeclaration>, IDeepCloneable<FunctionDeclaration>, IBufferMessage, IMessage
Reference documentation and code samples for the Cloud AI Platform v1beta1 API class FunctionDeclaration.
Structured representation of a function declaration as defined by the
OpenAPI 3.0 specification. Included
in this declaration are the function name, description, parameters and
response type. 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.
Implements
IMessageFunctionDeclaration, IEquatableFunctionDeclaration, IDeepCloneableFunctionDeclaration, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Beta1Assembly
Google.Cloud.AIPlatform.V1Beta1.dll
Constructors
FunctionDeclaration()
public FunctionDeclaration()
FunctionDeclaration(FunctionDeclaration)
public FunctionDeclaration(FunctionDeclaration other)
Parameter | |
---|---|
Name | Description |
other |
FunctionDeclaration |
Properties
Description
public string Description { get; set; }
Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.
Property Value | |
---|---|
Type | Description |
string |
Name
public string Name { get; set; }
Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64.
Property Value | |
---|---|
Type | Description |
string |
Parameters
public OpenApiSchema Parameters { get; set; }
Optional. Describes the parameters to this function in JSON Schema Object format. 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. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required:
- param1
Property Value | |
---|---|
Type | Description |
OpenApiSchema |
Response
public OpenApiSchema Response { get; set; }
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.
Property Value | |
---|---|
Type | Description |
OpenApiSchema |