Interface EmbedContentRequestOrBuilder (3.89.0)

3.88.0 (latest) 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

public interface EmbedContentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoTruncate() (deprecated)

public abstract 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 abstract Content getContent()

Required. Input content to be embedded.

optional .google.cloud.aiplatform.v1beta1.Content content = 2;

Returns
Type	Description
Content	The content.

getContentOrBuilder()

public abstract ContentOrBuilder getContentOrBuilder()

Required. Input content to be embedded.

optional .google.cloud.aiplatform.v1beta1.Content content = 2;

Returns
Type	Description
ContentOrBuilder

getEmbedContentConfig()

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

getEmbedContentConfigOrBuilder()

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