public static final class EmbedContentRequest.Builder extends GeneratedMessage.Builder<EmbedContentRequest.Builder> implements EmbedContentRequestOrBuilderRequest message for PredictionService.EmbedContent.
Protobuf type google.cloud.aiplatform.v1beta1.EmbedContentRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > EmbedContentRequest.BuilderImplements
EmbedContentRequestOrBuilderStatic 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 |
|
clearAutoTruncate() (deprecated)
public EmbedContentRequest.Builder clearAutoTruncate()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1057
Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
optional bool auto_truncate = 7 [deprecated = true, (.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.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
|
clearEmbedContentConfig()
public EmbedContentRequest.Builder clearEmbedContentConfig()Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| 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() (deprecated)
public EmbedContentRequest.Builder clearOutputDimensionality()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1051
Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
clearTaskType() (deprecated)
public EmbedContentRequest.Builder clearTaskType()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
clearTitle() (deprecated)
public EmbedContentRequest.Builder clearTitle()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
getAutoTruncate() (deprecated)
public boolean getAutoTruncate()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1057
Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The autoTruncate. |
getContent()
public Content getContent()Required. Input content to be embedded.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Returns | |
|---|---|
| Type | Description |
Content |
The content. |
getContentBuilder()
public Content.Builder getContentBuilder()Required. Input content to be embedded.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Returns | |
|---|---|
| Type | Description |
Content.Builder |
|
getContentOrBuilder()
public ContentOrBuilder getContentOrBuilder()Required. Input content to be embedded.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Returns | |
|---|---|
| Type | Description |
ContentOrBuilder |
|
getDefaultInstanceForType()
public EmbedContentRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEmbedContentConfig()
public EmbedContentRequest.EmbedContentConfig getEmbedContentConfig()Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.EmbedContentConfig |
The embedContentConfig. |
getEmbedContentConfigBuilder()
public EmbedContentRequest.EmbedContentConfig.Builder getEmbedContentConfigBuilder()Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.EmbedContentConfig.Builder |
|
getEmbedContentConfigOrBuilder()
public EmbedContentRequest.EmbedContentConfigOrBuilder getEmbedContentConfigOrBuilder()Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.EmbedContentConfigOrBuilder |
|
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() (deprecated)
public int getOutputDimensionality()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1051
Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The outputDimensionality. |
getTaskType() (deprecated)
public EmbedContentRequest.EmbeddingTaskType getTaskType()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.EmbeddingTaskType |
The taskType. |
getTaskTypeValue() (deprecated)
public int getTaskTypeValue()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for taskType. |
getTitle() (deprecated)
public String getTitle()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes() (deprecated)
public ByteString getTitleBytes()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
hasAutoTruncate() (deprecated)
public boolean hasAutoTruncate()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1057
Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
optional bool auto_truncate = 7 [deprecated = true, (.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.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the content field is set. |
hasEmbedContentConfig()
public boolean hasEmbedContentConfig()Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the embedContentConfig 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() (deprecated)
public boolean hasOutputDimensionality()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1051
Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the outputDimensionality field is set. |
hasTaskType() (deprecated)
public boolean hasTaskType()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the taskType field is set. |
hasTitle() (deprecated)
public boolean hasTitle()Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the title field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeContent(Content value)
public EmbedContentRequest.Builder mergeContent(Content value)Required. Input content to be embedded.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
Content |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
|
mergeEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)
public EmbedContentRequest.Builder mergeEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EmbedContentRequest.EmbedContentConfig |
| 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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public EmbedContentRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
|
setAutoTruncate(boolean value) (deprecated)
public EmbedContentRequest.Builder setAutoTruncate(boolean value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1057
Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe 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.
optional .google.cloud.aiplatform.v1beta1.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.
optional .google.cloud.aiplatform.v1beta1.Content content = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Content.Builder |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
|
setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)
public EmbedContentRequest.Builder setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EmbedContentRequest.EmbedContentConfig |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
|
setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig.Builder builderForValue)
public EmbedContentRequest.Builder setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig.Builder builderForValue)Optional. Configuration for the EmbedContent request.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
EmbedContentRequest.EmbedContentConfig.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 |
StringThe 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 |
ByteStringThe bytes for model to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
setOutputDimensionality(int value) (deprecated)
public EmbedContentRequest.Builder setOutputDimensionality(int value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1051
Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe outputDimensionality to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
setTaskType(EmbedContentRequest.EmbeddingTaskType value) (deprecated)
public EmbedContentRequest.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
EmbedContentRequest.EmbeddingTaskTypeThe taskType to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
setTaskTypeValue(int value) (deprecated)
public EmbedContentRequest.Builder setTaskTypeValue(int value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1045
Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
optional .google.cloud.aiplatform.v1beta1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for taskType to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
setTitle(String value) (deprecated)
public EmbedContentRequest.Builder setTitle(String value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe title to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |
setTitleBytes(ByteString value) (deprecated)
public EmbedContentRequest.Builder setTitleBytes(ByteString value)Deprecated. google.cloud.aiplatform.v1beta1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1beta1/prediction_service.proto;l=1040
Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for title to set. |
| Returns | |
|---|---|
| Type | Description |
EmbedContentRequest.Builder |
This builder for chaining. |