Class EmbedContentRequest (1.43.0)

Version latest

• 1.43.0 (latest)
• 1.42.0
• 1.40.0
• 1.38.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.30.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.20.1
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class EmbedContentRequest extends GeneratedMessage implements EmbedContentRequestOrBuilder

Request message for PredictionService.EmbedContent.

Protobuf type google.cloud.vertexai.v1.EmbedContentRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > EmbedContentRequest

Implements

EmbedContentRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
EmbedContentRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static EmbedContentRequest.Builder newBuilder()

Returns
Type	Description
EmbedContentRequest.Builder

newBuilder(EmbedContentRequest prototype)

public static EmbedContentRequest.Builder newBuilder(EmbedContentRequest prototype)

Parameter
Name	Description
prototype	EmbedContentRequest

Returns
Type	Description
EmbedContentRequest.Builder

parseDelimitedFrom(InputStream input)

public static EmbedContentRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static EmbedContentRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EmbedContentRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EmbedContentRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static EmbedContentRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static EmbedContentRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<EmbedContentRequest> parser()

Returns
Type	Description
Parser<EmbedContentRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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.vertexai.v1.Content content = 2;

Returns
Type	Description
Content	The content.

getContentOrBuilder()

public ContentOrBuilder getContentOrBuilder()

Required. Input content to be embedded. Required.

optional .google.cloud.vertexai.v1.Content content = 2;

Returns
Type	Description
ContentOrBuilder

getDefaultInstanceForType()

public EmbedContentRequest getDefaultInstanceForType()

Returns
Type	Description
EmbedContentRequest

getModel()

public String 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()

Returns
Type	Description
Parser<EmbedContentRequest>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getTaskType()

public EmbedContentRequest.EmbeddingTaskType getTaskType()

Optional. The task type of the embedding.

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

Returns
Type	Description
EmbedContentRequest.EmbeddingTaskType	The taskType.

getTaskTypeValue()

public int getTaskTypeValue()

Optional. The task type of the embedding.

optional .google.cloud.vertexai.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()

public String 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.vertexai.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.vertexai.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()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public EmbedContentRequest.Builder newBuilderForType()

Returns
Type	Description
EmbedContentRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected EmbedContentRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
EmbedContentRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public EmbedContentRequest.Builder toBuilder()

Returns
Type	Description
EmbedContentRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException