Google Cloud Ai Platform V1 Client - Class OutputFieldSpec (1.36.0)

Version latest

• 1.36.0 (latest)
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.1
• 1.31.0
• 1.30.0
• 1.26.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.1
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class OutputFieldSpec.

Defines a specification for a single output field.

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ field_name	string Required. The name of the output field.
↳ guidance	string Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.
↳ field_type	int Optional. The data type of the field. Defaults to CONTENT if not set.

getFieldName

Required. The name of the output field.

Returns
Type	Description
string

setFieldName

Required. The name of the output field.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getGuidance

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

Returns
Type	Description
string

setGuidance

Optional. Optional, but recommended. Additional guidance specific to this field to provide targeted instructions for the LLM to generate the content of a single output field. While the LLM can sometimes infer content from the field name, providing explicit guidance is preferred.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getFieldType

Optional. The data type of the field. Defaults to CONTENT if not set.

Returns
Type	Description
int	Enum of type FieldType.

setFieldType

Optional. The data type of the field. Defaults to CONTENT if not set.

Parameter
Name	Description
var	int Enum of type FieldType.

Returns
Type	Description
$this