Package com.google.cloud.aiplatform.v1

Class FunctionDeclaration

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FunctionDeclaration
All Implemented Interfaces:
FunctionDeclarationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FunctionDeclaration extends com.google.protobuf.GeneratedMessage implements FunctionDeclarationOrBuilder
 Structured representation of a function declaration as defined by the
 [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). 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
See Also:

  • Field Details

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • PARAMETERS_FIELD_NUMBER

      public static final int PARAMETERS_FIELD_NUMBER
      See Also:

    • PARAMETERS_JSON_SCHEMA_FIELD_NUMBER

      public static final int PARAMETERS_JSON_SCHEMA_FIELD_NUMBER
      See Also:

    • RESPONSE_FIELD_NUMBER

      public static final int RESPONSE_FIELD_NUMBER
      See Also:

    • RESPONSE_JSON_SCHEMA_FIELD_NUMBER

      public static final int RESPONSE_JSON_SCHEMA_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       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];
      Specified by:
      getName in interface FunctionDeclarationOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.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];
      Specified by:
      getNameBytes in interface FunctionDeclarationOrBuilder
      Returns:
      The bytes for name.

    • getDescription

      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];
      Specified by:
      getDescription in interface FunctionDeclarationOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.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];
      Specified by:
      getDescriptionBytes in interface FunctionDeclarationOrBuilder
      Returns:
      The bytes for description.

    • hasParameters

      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:
 - param1
      .google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasParameters in interface FunctionDeclarationOrBuilder
      Returns:
      Whether the parameters field is set.

    • getParameters

      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:
 - param1
      .google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParameters in interface FunctionDeclarationOrBuilder
      Returns:
      The parameters.

    • getParametersOrBuilder

      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:
 - param1
      .google.cloud.aiplatform.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParametersOrBuilder in interface FunctionDeclarationOrBuilder

    • hasParametersJsonSchema

      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];
      Specified by:
      hasParametersJsonSchema in interface FunctionDeclarationOrBuilder
      Returns:
      Whether the parametersJsonSchema field is set.

    • getParametersJsonSchema

      public com.google.protobuf.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];
      Specified by:
      getParametersJsonSchema in interface FunctionDeclarationOrBuilder
      Returns:
      The parametersJsonSchema.

    • getParametersJsonSchemaOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getParametersJsonSchemaOrBuilder in interface FunctionDeclarationOrBuilder

    • hasResponse

      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];
      Specified by:
      hasResponse in interface FunctionDeclarationOrBuilder
      Returns:
      Whether the response field is set.

    • getResponse

      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];
      Specified by:
      getResponse in interface FunctionDeclarationOrBuilder
      Returns:
      The response.

    • getResponseOrBuilder

      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];
      Specified by:
      getResponseOrBuilder in interface FunctionDeclarationOrBuilder

    • hasResponseJsonSchema

      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];
      Specified by:
      hasResponseJsonSchema in interface FunctionDeclarationOrBuilder
      Returns:
      Whether the responseJsonSchema field is set.

    • getResponseJsonSchema

      public com.google.protobuf.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];
      Specified by:
      getResponseJsonSchema in interface FunctionDeclarationOrBuilder
      Returns:
      The responseJsonSchema.

    • getResponseJsonSchemaOrBuilder

      public com.google.protobuf.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];
      Specified by:
      getResponseJsonSchemaOrBuilder in interface FunctionDeclarationOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static FunctionDeclaration parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FunctionDeclaration parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FunctionDeclaration parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FunctionDeclaration parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FunctionDeclaration parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FunctionDeclaration parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FunctionDeclaration parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public FunctionDeclaration.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FunctionDeclaration.Builder newBuilder()

    • newBuilder

      public static FunctionDeclaration.Builder newBuilder(FunctionDeclaration prototype)

    • toBuilder

      public FunctionDeclaration.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FunctionDeclaration.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FunctionDeclaration getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FunctionDeclaration> parser()

    • getParserForType

      public com.google.protobuf.Parser<FunctionDeclaration> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public FunctionDeclaration getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder