Interface EmbedContentRequestOrBuilder (3.82.0)

public interface EmbedContentRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoTruncate()

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

Required. Input content to be embedded. Required.

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. Required.

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

Returns
Type Description
ContentOrBuilder

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

public abstract 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 abstract EmbedContentRequest.EmbeddingTaskType getTaskType()

Optional. The task type of the embedding.

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

Returns
Type Description
EmbedContentRequest.EmbeddingTaskType

The taskType.

getTaskTypeValue()

public abstract int getTaskTypeValue()

Optional. The task type of the embedding.

optional .google.cloud.aiplatform.v1beta1.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 abstract 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 abstract 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 abstract 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 abstract boolean hasContent()

Required. Input content to be embedded. Required.

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

Returns
Type Description
boolean

Whether the content 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()

public abstract 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 abstract boolean hasTaskType()

Optional. The task type of the embedding.

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

Returns
Type Description
boolean

Whether the taskType field is set.

hasTitle()

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