ParameterDefinition

Defines the properties of a parameter. Used to define parameters used in the agent and the input / output parameters for each fulfillment.

JSON representation 
{
  "name": string,
  "type": enum (ParameterType),
  "typeSchema": {
    object (TypeSchema)
  },
  "description": string
}
Fields
name

string

Required. Name of parameter.
type
(deprecated)

enum (ParameterType)

Type of parameter.
typeSchema

object (TypeSchema)

Optional. Type schema of parameter.
description

string

Human-readable description of the parameter. Limited to 300 characters.

ParameterType

Parameter types are used for validation. These types are consistent with google.protobuf.Value.

Enums
PARAMETER_TYPE_UNSPECIFIED Not specified. No validation will be performed.
STRING Represents any string value.
NUMBER Represents any number value.
BOOLEAN Represents a boolean value.
NULL Represents a null value.
OBJECT Represents any object value.
LIST Represents a repeated value.

TypeSchema

Encapsulates different type schema variations: either a reference to an a schema that's already defined by a tool, or an inline definition.

JSON representation 
{

  // Union field schema can be only one of the following:
  "inlineSchema": {
    object (InlineSchema)
  },
  "schemaReference": {
    object (SchemaReference)
  }
  // End of list of possible types for union field schema.
}
Fields
Union field schema. The encapsulated schema. schema can be only one of the following:
inlineSchema

object (InlineSchema)

Set if this is an inline schema definition.
schemaReference

object (SchemaReference)

Set if this is a schema reference.

InlineSchema

A type schema object that's specified inline.

JSON representation 
{
  "type": enum (DataType),
  "items": {
    object (TypeSchema)
  }
}
Fields
type

enum (DataType)

Data type of the schema.
items

object (TypeSchema)

Schema of the elements if this is an ARRAY type.

DataType

Defines data types that are supported for inlined schemas. These types are consistent with google.protobuf.Value.

Enums
DATA_TYPE_UNSPECIFIED Not specified.
STRING Represents any string value.
NUMBER Represents any number value.
BOOLEAN Represents a boolean value.
ARRAY Represents a repeated value.

SchemaReference

A reference to the schema of an existing tool.

JSON representation 
{
  "tool": string,
  "schema": string
}
Fields
tool

string

The tool that contains this schema definition. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/tools/<ToolID>.
schema

string

The name of the schema.