Interface EmbedContentRequest.EmbedContentConfigOrBuilder (3.89.0)

public static interface EmbedContentRequest.EmbedContentConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudioTrackExtraction()

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

getDocumentOcr()

public abstract 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 abstract 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 abstract EmbedContentRequest.EmbeddingTaskType getTaskType()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

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

Returns
Type Description
EmbedContentRequest.EmbeddingTaskType

The taskType.

getTaskTypeValue()

public abstract int getTaskTypeValue()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

optional .google.cloud.aiplatform.v1.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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasTaskType()

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

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

Returns
Type Description
boolean

Whether the taskType field is set.

hasTitle()

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