Class EmbedContentRequest.Builder (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 static final class EmbedContentRequest.Builder extends GeneratedMessage.Builder<EmbedContentRequest.Builder> implements EmbedContentRequestOrBuilder

Request message for PredictionService.EmbedContent.

Protobuf type google.cloud.vertexai.v1.EmbedContentRequest

Inheritance

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

Implements

EmbedContentRequestOrBuilder

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 build()

Returns
Type	Description
EmbedContentRequest

buildPartial()

public EmbedContentRequest buildPartial()

Returns
Type	Description
EmbedContentRequest

clear()

public EmbedContentRequest.Builder clear()

Returns
Type	Description
EmbedContentRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearAutoTruncate()

public EmbedContentRequest.Builder clearAutoTruncate()

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
EmbedContentRequest.Builder	This builder for chaining.

clearContent()

public EmbedContentRequest.Builder clearContent()

Required. Input content to be embedded. Required.

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

Returns
Type	Description
EmbedContentRequest.Builder

clearModel()

public EmbedContentRequest.Builder clearModel()

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
EmbedContentRequest.Builder	This builder for chaining.

clearOutputDimensionality()

public EmbedContentRequest.Builder clearOutputDimensionality()

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
EmbedContentRequest.Builder	This builder for chaining.

clearTaskType()

public EmbedContentRequest.Builder clearTaskType()

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.Builder	This builder for chaining.

clearTitle()

public EmbedContentRequest.Builder clearTitle()

Optional. An optional title for the text.

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

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

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.

getContentBuilder()

public Content.Builder getContentBuilder()

Required. Input content to be embedded. Required.

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

Returns
Type	Description
Content.Builder

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

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.

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

mergeContent(Content value)

public EmbedContentRequest.Builder mergeContent(Content value)

Required. Input content to be embedded. Required.

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

Parameter
Name	Description
value	Content

Returns
Type	Description
EmbedContentRequest.Builder

mergeFrom(EmbedContentRequest other)

public EmbedContentRequest.Builder mergeFrom(EmbedContentRequest other)

Parameter
Name	Description
other	EmbedContentRequest

Returns
Type	Description
EmbedContentRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
EmbedContentRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public EmbedContentRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
EmbedContentRequest.Builder

Overrides

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

setAutoTruncate(boolean value)

public EmbedContentRequest.Builder setAutoTruncate(boolean value)

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];

Parameter
Name	Description
value	boolean The autoTruncate to set.

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setContent(Content value)

public EmbedContentRequest.Builder setContent(Content value)

Required. Input content to be embedded. Required.

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

Parameter
Name	Description
value	Content

Returns
Type	Description
EmbedContentRequest.Builder

setContent(Content.Builder builderForValue)

public EmbedContentRequest.Builder setContent(Content.Builder builderForValue)

Required. Input content to be embedded. Required.

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

Parameter
Name	Description
builderForValue	Content.Builder

Returns
Type	Description
EmbedContentRequest.Builder

setModel(String value)

public EmbedContentRequest.Builder setModel(String value)

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) = { ... }

Parameter
Name	Description
value	String The model to set.

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setModelBytes(ByteString value)

public EmbedContentRequest.Builder setModelBytes(ByteString value)

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) = { ... }

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

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setOutputDimensionality(int value)

public EmbedContentRequest.Builder setOutputDimensionality(int value)

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];

Parameter
Name	Description
value	int The outputDimensionality to set.

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setTaskType(EmbedContentRequest.EmbeddingTaskType value)

public EmbedContentRequest.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)

Optional. The task type of the embedding.

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

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

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setTaskTypeValue(int value)

public EmbedContentRequest.Builder setTaskTypeValue(int value)

Optional. The task type of the embedding.

optional .google.cloud.vertexai.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.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.Builder	This builder for chaining.

setTitle(String value)

public EmbedContentRequest.Builder setTitle(String value)

Optional. An optional title for the text.

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

Parameter
Name	Description
value	String The title to set.

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.

setTitleBytes(ByteString value)

public EmbedContentRequest.Builder setTitleBytes(ByteString value)

Optional. An optional title for the text.

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

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

Returns
Type	Description
EmbedContentRequest.Builder	This builder for chaining.