Class GoogleCloudAiplatformV1beta1FunctionDeclaration

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.

Inheritance

object

GoogleCloudAiplatformV1beta1FunctionDeclaration

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseML.v2beta.Data

Assembly: Google.Apis.FirebaseML.v2beta.dll

Syntax

public class GoogleCloudAiplatformV1beta1FunctionDeclaration : IDirectResponseSchema

Properties

Description

Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

Name

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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Parameters

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

Declaration

[JsonProperty("parameters")]
public virtual GoogleCloudAiplatformV1beta1Schema Parameters { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1Schema

ParametersJsonSchema

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:

{ "type": "object", "properties":
{ "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required":
["name", "age"], "propertyOrdering": ["name", "age"] }

This field is mutually exclusive with parameters.

Declaration

[JsonProperty("parametersJsonSchema")]
public virtual object ParametersJsonSchema { get; set; }

Property Value

Type	Description
object

Response

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.

Declaration

[JsonProperty("response")]
public virtual GoogleCloudAiplatformV1beta1Schema Response { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1Schema

ResponseJsonSchema

Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with response.

Declaration

[JsonProperty("responseJsonSchema")]
public virtual object ResponseJsonSchema { get; set; }

Property Value

Type	Description
object

Implements

IDirectResponseSchema