com.google.cloud.aiplatform.v1

Interface OutputFieldSpecOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

OutputFieldSpec, OutputFieldSpec.Builder

@Generated
public interface OutputFieldSpecOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFieldName() Required.
com.google.protobuf.ByteString	getFieldNameBytes() Required.
OutputFieldSpec.FieldType	getFieldType() Optional.
int	getFieldTypeValue() Optional.
String	getGuidance() Optional.
com.google.protobuf.ByteString	getGuidanceBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFieldName

String getFieldName()

 Required. The name of the output field.
 

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

Returns:

The fieldName.

getFieldNameBytes

com.google.protobuf.ByteString getFieldNameBytes()

 Required. The name of the output field.
 

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

Returns:

The bytes for fieldName.

getGuidance

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:

The guidance.

getGuidanceBytes

com.google.protobuf.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:

The bytes for guidance.

getFieldTypeValue

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:

The enum numeric value on the wire for fieldType.

getFieldType

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:

The fieldType.