Send feedback
Class EmbedContentRequest (3.82.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version latestkeyboard_arrow_down
public final class EmbedContentRequest extends GeneratedMessageV3 implements EmbedContentRequestOrBuilder
Request message for
PredictionService.EmbedContent .
Protobuf type google.cloud.aiplatform.v1.EmbedContentRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTO_TRUNCATE_FIELD_NUMBER
public static final int AUTO_TRUNCATE_FIELD_NUMBER
Field Value
Type
Description
int
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
Type
Description
int
MODEL_FIELD_NUMBER
public static final int MODEL_FIELD_NUMBER
Field Value
Type
Description
int
OUTPUT_DIMENSIONALITY_FIELD_NUMBER
public static final int OUTPUT_DIMENSIONALITY_FIELD_NUMBER
Field Value
Type
Description
int
TASK_TYPE_FIELD_NUMBER
public static final int TASK_TYPE_FIELD_NUMBER
Field Value
Type
Description
int
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER
Field Value
Type
Description
int
Static Methods
getDefaultInstance()
public static EmbedContentRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static EmbedContentRequest . Builder newBuilder ()
newBuilder(EmbedContentRequest prototype)
public static EmbedContentRequest . Builder newBuilder ( EmbedContentRequest prototype )
parseDelimitedFrom(InputStream input)
public static EmbedContentRequest parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static EmbedContentRequest parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static EmbedContentRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static EmbedContentRequest parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static EmbedContentRequest parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static EmbedContentRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static EmbedContentRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<EmbedContentRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
getAutoTruncate()
public boolean getAutoTruncate ()
Optional. Whether to silently truncate the input content if it's longer
than the maximum sequence length.
optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
The autoTruncate.
getContent()
public Content getContent ()
Required. Input content to be embedded. Required.
optional .google.cloud.aiplatform.v1.Content content = 2;
Returns
Type
Description
Content
The content.
getContentOrBuilder()
public ContentOrBuilder getContentOrBuilder ()
Required. Input content to be embedded. Required.
optional .google.cloud.aiplatform.v1.Content content = 2;
getDefaultInstanceForType()
public EmbedContentRequest getDefaultInstanceForType ()
getModel()
Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
optional string model = 1 [(.google.api.resource_reference) = { ... }
Returns
Type
Description
String
The model.
getModelBytes()
public ByteString getModelBytes ()
Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
optional string model = 1 [(.google.api.resource_reference) = { ... }
Returns
Type
Description
ByteString
The bytes for model.
getOutputDimensionality()
public int getOutputDimensionality ()
Optional. Optional reduced dimension for the output embedding. If set,
excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
int
The outputDimensionality.
getParserForType()
public Parser<EmbedContentRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
getTaskType()
public EmbedContentRequest . EmbeddingTaskType getTaskType ()
Optional. The task type of the embedding.
optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
getTaskTypeValue()
public int getTaskTypeValue ()
Optional. The task type of the embedding.
optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
int
The enum numeric value on the wire for taskType.
getTitle()
Optional. An optional title for the text.
optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
String
The title.
getTitleBytes()
public ByteString getTitleBytes ()
Optional. An optional title for the text.
optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
ByteString
The bytes for title.
hasAutoTruncate()
public boolean hasAutoTruncate ()
Optional. Whether to silently truncate the input content if it's longer
than the maximum sequence length.
optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
Whether the autoTruncate field is set.
hasContent()
public boolean hasContent ()
Required. Input content to be embedded. Required.
optional .google.cloud.aiplatform.v1.Content content = 2;
Returns
Type
Description
boolean
Whether the content field is set.
hasModel()
public boolean hasModel ()
Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
optional string model = 1 [(.google.api.resource_reference) = { ... }
Returns
Type
Description
boolean
Whether the model field is set.
hasOutputDimensionality()
public boolean hasOutputDimensionality ()
Optional. Optional reduced dimension for the output embedding. If set,
excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [(.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.
optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
Whether the taskType field is set.
hasTitle()
public boolean hasTitle ()
Optional. An optional title for the text.
optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type
Description
boolean
Whether the title field is set.
hashCode()
Returns
Type
Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public EmbedContentRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected EmbedContentRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
toBuilder()
public EmbedContentRequest . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-09 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-01-09 UTC."],[],[]]