public final class FunctionDeclaration extends GeneratedMessageV3 implements FunctionDeclarationOrBuilder
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.
Protobuf type google.cloud.aiplatform.v1.FunctionDeclaration
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PARAMETERS_JSON_SCHEMA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int RESPONSE_JSON_SCHEMA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FunctionDeclaration getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FunctionDeclaration.Builder newBuilder()
public static FunctionDeclaration.Builder newBuilder(FunctionDeclaration prototype)
public static FunctionDeclaration parseDelimitedFrom(InputStream input)
public static FunctionDeclaration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FunctionDeclaration parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FunctionDeclaration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FunctionDeclaration parseFrom(ByteString data)
public static FunctionDeclaration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FunctionDeclaration parseFrom(CodedInputStream input)
public static FunctionDeclaration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FunctionDeclaration parseFrom(InputStream input)
public static FunctionDeclaration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FunctionDeclaration parseFrom(ByteBuffer data)
public static FunctionDeclaration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FunctionDeclaration> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public FunctionDeclaration getDefaultInstanceForType()
public String getDescription()
Optional. Description and purpose of the function.
Model uses it to decide how and whether to call the function.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Optional. Description and purpose of the function.
Model uses it to decide how and whether to call the function.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
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.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Schema getParameters()
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:
.google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Schema |
The parameters.
|
public Value getParametersJsonSchema()
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`.
.google.protobuf.Value parameters_json_schema = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Value |
The parametersJsonSchema.
|
public ValueOrBuilder getParametersJsonSchemaOrBuilder()
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`.
.google.protobuf.Value parameters_json_schema = 5 [(.google.api.field_behavior) = OPTIONAL];
public SchemaOrBuilder getParametersOrBuilder()
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:
.google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
public Parser<FunctionDeclaration> getParserForType()
Overrides
public Schema getResponse()
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.
.google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Schema |
The response.
|
public Value getResponseJsonSchema()
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.
.google.protobuf.Value response_json_schema = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Value |
The responseJsonSchema.
|
public ValueOrBuilder getResponseJsonSchemaOrBuilder()
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.
.google.protobuf.Value response_json_schema = 6 [(.google.api.field_behavior) = OPTIONAL];
public SchemaOrBuilder getResponseOrBuilder()
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.
.google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasParameters()
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:
.google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the parameters field is set.
|
public boolean hasParametersJsonSchema()
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`.
.google.protobuf.Value parameters_json_schema = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the parametersJsonSchema field is set.
|
public boolean hasResponse()
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.
.google.cloud.aiplatform.v1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the response field is set.
|
public boolean hasResponseJsonSchema()
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.
.google.protobuf.Value response_json_schema = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the responseJsonSchema field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public FunctionDeclaration.Builder newBuilderForType()
protected FunctionDeclaration.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FunctionDeclaration.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
