Class EmbedContentRequest.EmbedContentConfig.Builder (3.89.0)

3.88.0 (latest) 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

public static final class EmbedContentRequest.EmbedContentConfig.Builder extends GeneratedMessage.Builder<EmbedContentRequest.EmbedContentConfig.Builder> implements EmbedContentRequest.EmbedContentConfigOrBuilder

Configurations for the EmbedContent API.

Protobuf type google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > EmbedContentRequest.EmbedContentConfig.Builder

Implements

EmbedContentRequest.EmbedContentConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public EmbedContentRequest.EmbedContentConfig build()

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig

buildPartial()

public EmbedContentRequest.EmbedContentConfig buildPartial()

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig

clear()

public EmbedContentRequest.EmbedContentConfig.Builder clear()

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAudioTrackExtraction()

public EmbedContentRequest.EmbedContentConfig.Builder clearAudioTrackExtraction()

Optional. Whether to extract audio from video content.

optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

clearAutoTruncate()

public EmbedContentRequest.EmbedContentConfig.Builder clearAutoTruncate()

Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.

Only applicable to text-only embedding models.

optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

clearDocumentOcr()

public EmbedContentRequest.EmbedContentConfig.Builder clearDocumentOcr()

Optional. Whether to enable OCR for document content.

optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

clearOutputDimensionality()

public EmbedContentRequest.EmbedContentConfig.Builder clearOutputDimensionality()

Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

clearTaskType()

public EmbedContentRequest.EmbedContentConfig.Builder clearTaskType()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

clearTitle()

public EmbedContentRequest.EmbedContentConfig.Builder clearTitle()

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

getAudioTrackExtraction()

public boolean getAudioTrackExtraction()

Optional. Whether to extract audio from video content.

optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The audioTrackExtraction.

getAutoTruncate()

public boolean getAutoTruncate()

Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.

Only applicable to text-only embedding models.

optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The autoTruncate.

getDefaultInstanceForType()

public EmbedContentRequest.EmbedContentConfig getDefaultInstanceForType()

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getDocumentOcr()

public boolean getDocumentOcr()

Optional. Whether to enable OCR for document content.

optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The documentOcr.

getOutputDimensionality()

public int getOutputDimensionality()

Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The outputDimensionality.

getTaskType()

public EmbedContentRequest.EmbeddingTaskType getTaskType()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
EmbedContentRequest.EmbeddingTaskType	The taskType.

getTaskTypeValue()

public int getTaskTypeValue()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The enum numeric value on the wire for taskType.

getTitle()

public String getTitle()

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The title.

getTitleBytes()

public ByteString getTitleBytes()

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for title.

hasAudioTrackExtraction()

public boolean hasAudioTrackExtraction()

Optional. Whether to extract audio from video content.

optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the audioTrackExtraction field is set.

hasAutoTruncate()

public boolean hasAutoTruncate()

Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.

Only applicable to text-only embedding models.

optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the autoTruncate field is set.

hasDocumentOcr()

public boolean hasDocumentOcr()

Optional. Whether to enable OCR for document content.

optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the documentOcr field is set.

hasOutputDimensionality()

public boolean hasOutputDimensionality()

Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the outputDimensionality field is set.

hasTaskType()

public boolean hasTaskType()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the taskType field is set.

hasTitle()

public boolean hasTitle()

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the title field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(EmbedContentRequest.EmbedContentConfig other)

public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(EmbedContentRequest.EmbedContentConfig other)

Parameter
Name	Description
other	EmbedContentRequest.EmbedContentConfig

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EmbedContentRequest.EmbedContentConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

setAudioTrackExtraction(boolean value)

public EmbedContentRequest.EmbedContentConfig.Builder setAudioTrackExtraction(boolean value)

Optional. Whether to extract audio from video content.

optional bool audio_track_extraction = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The audioTrackExtraction to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setAutoTruncate(boolean value)

public EmbedContentRequest.EmbedContentConfig.Builder setAutoTruncate(boolean value)

Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.

Only applicable to text-only embedding models.

optional bool auto_truncate = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The autoTruncate to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setDocumentOcr(boolean value)

public EmbedContentRequest.EmbedContentConfig.Builder setDocumentOcr(boolean value)

Optional. Whether to enable OCR for document content.

optional bool document_ocr = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	boolean The documentOcr to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setOutputDimensionality(int value)

public EmbedContentRequest.EmbedContentConfig.Builder setOutputDimensionality(int value)

Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

optional int32 output_dimensionality = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The outputDimensionality to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setTaskType(EmbedContentRequest.EmbeddingTaskType value)

public EmbedContentRequest.EmbedContentConfig.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	EmbedContentRequest.EmbeddingTaskType The taskType to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setTaskTypeValue(int value)

public EmbedContentRequest.EmbedContentConfig.Builder setTaskTypeValue(int value)

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	int The enum numeric value on the wire for taskType to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setTitle(String value)

public EmbedContentRequest.EmbedContentConfig.Builder setTitle(String value)

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The title to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.

setTitleBytes(ByteString value)

public EmbedContentRequest.EmbedContentConfig.Builder setTitleBytes(ByteString value)

Optional. The title for the text.

Only applicable to text-only embedding models.

optional string title = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for title to set.

Returns
Type	Description
EmbedContentRequest.EmbedContentConfig.Builder	This builder for chaining.