com.google.cloud.aiplatform.v1

Class EmbedContentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1.EmbedContentRequest

All Implemented Interfaces:

EmbedContentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated
public final class EmbedContentRequest
extends com.google.protobuf.GeneratedMessage
implements EmbedContentRequestOrBuilder

 Request message for
 [PredictionService.EmbedContent][google.cloud.aiplatform.v1.PredictionService.EmbedContent].
 

Protobuf type google.cloud.aiplatform.v1.EmbedContentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EmbedContentRequest.Builder Request message for [PredictionService.EmbedContent][google.cloud.aiplatform.v1.PredictionService.EmbedContent].
static class	EmbedContentRequest.EmbeddingTaskType Represents a downstream task the embeddings will be used for.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO_TRUNCATE_FIELD_NUMBER
static int	CONTENT_FIELD_NUMBER
static int	MODEL_FIELD_NUMBER
static int	OUTPUT_DIMENSIONALITY_FIELD_NUMBER
static int	TASK_TYPE_FIELD_NUMBER
static int	TITLE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
boolean	getAutoTruncate() Optional.
Content	getContent() Required.
ContentOrBuilder	getContentOrBuilder() Required.
static EmbedContentRequest	getDefaultInstance()
EmbedContentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getModel() Required.
com.google.protobuf.ByteString	getModelBytes() Required.
int	getOutputDimensionality() Optional.
com.google.protobuf.Parser<EmbedContentRequest>	getParserForType()
int	getSerializedSize()
EmbedContentRequest.EmbeddingTaskType	getTaskType() Optional.
int	getTaskTypeValue() Optional.
String	getTitle() Optional.
com.google.protobuf.ByteString	getTitleBytes() Optional.
boolean	hasAutoTruncate() Optional.
boolean	hasContent() Required.
int	hashCode()
boolean	hasModel() Required.
boolean	hasOutputDimensionality() Optional.
boolean	hasTaskType() Optional.
boolean	hasTitle() Optional.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static EmbedContentRequest.Builder	newBuilder()
static EmbedContentRequest.Builder	newBuilder(EmbedContentRequest prototype)
EmbedContentRequest.Builder	newBuilderForType()
protected EmbedContentRequest.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static EmbedContentRequest	parseDelimitedFrom(InputStream input)
static EmbedContentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EmbedContentRequest	parseFrom(byte[] data)
static EmbedContentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EmbedContentRequest	parseFrom(ByteBuffer data)
static EmbedContentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EmbedContentRequest	parseFrom(com.google.protobuf.ByteString data)
static EmbedContentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EmbedContentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static EmbedContentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static EmbedContentRequest	parseFrom(InputStream input)
static EmbedContentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<EmbedContentRequest>	parser()
EmbedContentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER

See Also:

Constant Field Values

TASK_TYPE_FIELD_NUMBER

public static final int TASK_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_DIMENSIONALITY_FIELD_NUMBER

public static final int OUTPUT_DIMENSIONALITY_FIELD_NUMBER

See Also:

Constant Field Values

AUTO_TRUNCATE_FIELD_NUMBER

public static final int AUTO_TRUNCATE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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

Specified by:

hasModel in interface EmbedContentRequestOrBuilder

Returns:

Whether the model field is set.

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

Specified by:

getModel in interface EmbedContentRequestOrBuilder

Returns:

The model.

getModelBytes

public com.google.protobuf.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) = { ... }

Specified by:

getModelBytes in interface EmbedContentRequestOrBuilder

Returns:

The bytes for model.

hasContent

public boolean hasContent()

 Required. Input content to be embedded. Required.
 

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

Specified by:

hasContent in interface EmbedContentRequestOrBuilder

Returns:

Whether the content field is set.

getContent

public Content getContent()

 Required. Input content to be embedded. Required.
 

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

Specified by:

getContent in interface EmbedContentRequestOrBuilder

Returns:

The content.

getContentOrBuilder

public ContentOrBuilder getContentOrBuilder()

 Required. Input content to be embedded. Required.
 

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

Specified by:

getContentOrBuilder in interface EmbedContentRequestOrBuilder

hasTitle

public boolean hasTitle()

 Optional. An optional title for the text.
 

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

Specified by:

hasTitle in interface EmbedContentRequestOrBuilder

Returns:

Whether the title field is set.

getTitle

public String getTitle()

 Optional. An optional title for the text.
 

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

Specified by:

getTitle in interface EmbedContentRequestOrBuilder

Returns:

The title.

getTitleBytes

public com.google.protobuf.ByteString getTitleBytes()

 Optional. An optional title for the text.
 

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

Specified by:

getTitleBytes in interface EmbedContentRequestOrBuilder

Returns:

The bytes for title.

hasTaskType

public boolean hasTaskType()

 Optional. The task type of the embedding.
 

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

Specified by:

hasTaskType in interface EmbedContentRequestOrBuilder

Returns:

Whether the taskType field is set.

getTaskTypeValue

public int getTaskTypeValue()

 Optional. The task type of the embedding.
 

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

Specified by:

getTaskTypeValue in interface EmbedContentRequestOrBuilder

Returns:

The enum numeric value on the wire for taskType.

getTaskType

public EmbedContentRequest.EmbeddingTaskType getTaskType()

 Optional. The task type of the embedding.
 

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

Specified by:

getTaskType in interface EmbedContentRequestOrBuilder

Returns:

The taskType.

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

Specified by:

hasOutputDimensionality in interface EmbedContentRequestOrBuilder

Returns:

Whether the outputDimensionality field is set.

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

Specified by:

getOutputDimensionality in interface EmbedContentRequestOrBuilder

Returns:

The outputDimensionality.

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

Specified by:

hasAutoTruncate in interface EmbedContentRequestOrBuilder

Returns:

Whether the autoTruncate field is set.

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

Specified by:

getAutoTruncate in interface EmbedContentRequestOrBuilder

Returns:

The autoTruncate.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static EmbedContentRequest parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static EmbedContentRequest parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static EmbedContentRequest parseFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static EmbedContentRequest parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static EmbedContentRequest parseDelimitedFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseFrom

public static EmbedContentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

public static EmbedContentRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

newBuilderForType

public EmbedContentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static EmbedContentRequest.Builder newBuilder()

newBuilder

public static EmbedContentRequest.Builder newBuilder(EmbedContentRequest prototype)

toBuilder

public EmbedContentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected EmbedContentRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static EmbedContentRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<EmbedContentRequest> parser()

getParserForType

public com.google.protobuf.Parser<EmbedContentRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public EmbedContentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder