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 \ V1Methods
__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 |
|