Interface OutputFieldSpecOrBuilder (3.74.0)

public interface OutputFieldSpecOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFieldName()

public abstract String getFieldName()

Required. The name of the output field.

string field_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The fieldName.

getFieldNameBytes()

public abstract ByteString getFieldNameBytes()

Required. The name of the output field.

string field_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for fieldName.

getFieldType()

public abstract OutputFieldSpec.FieldType getFieldType()

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

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
OutputFieldSpec.FieldType

The fieldType.

getFieldTypeValue()

public abstract int getFieldTypeValue()

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

.google.cloud.aiplatform.v1.OutputFieldSpec.FieldType field_type = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for fieldType.

getGuidance()

public abstract String 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.

string guidance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The guidance.

getGuidanceBytes()

public abstract ByteString getGuidanceBytes()

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.

string guidance = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for guidance.