Console
    Contact Us Start free

    Google Cloud Ai Platform V1 Client - Class FunctionDeclaration (1.35.0)

    Reference documentation and code samples for the Google Cloud Ai Platform V1 Client 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.

    Generated from protobuf message google.cloud.aiplatform.v1.FunctionDeclaration

    Namespace

    Google \ Cloud \ AIPlatform \ V1

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    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.

    ↳ description
    string

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

    ↳ parameters
    Schema

    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

    ↳ parameters_json_schema
    Google\Protobuf\Value

    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 .

    ↳ response
    Schema

    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.

    ↳ response_json_schema
    Google\Protobuf\Value

    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 .

    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.

    Returns
    Type
    Description
    string

    setName

    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.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDescription

    Optional. Description and purpose of the function.

    Model uses it to decide how and whether to call the function.

    Returns
    Type
    Description
    string

    setDescription

    Optional. Description and purpose of the function.

    Model uses it to decide how and whether to call the function.

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    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
    Returns
    Type
    Description
    Schema |null

    hasParameters

    clearParameters

    setParameters

    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
    Parameter
    Name
    Description
    var
    Schema
    Returns
    Type
    Description
    $this

    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 .

    Returns
    Type
    Description
    Google\Protobuf\Value |null

    hasParametersJsonSchema

    clearParametersJsonSchema

    setParametersJsonSchema

    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 .

    Parameter
    Name
    Description
    var
    Google\Protobuf\Value
    Returns
    Type
    Description
    $this

    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.

    Returns
    Type
    Description
    Schema |null

    hasResponse

    clearResponse

    setResponse

    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.

    Parameter
    Name
    Description
    var
    Schema
    Returns
    Type
    Description
    $this

    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 .

    Returns
    Type
    Description
    Google\Protobuf\Value |null

    hasResponseJsonSchema

    clearResponseJsonSchema

    setResponseJsonSchema

    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 .

    Parameter
    Name
    Description
    var
    Google\Protobuf\Value
    Returns
    Type
    Description
    $this
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: