Class EmbedContentResponse (3.82.0)

public final class EmbedContentResponse extends GeneratedMessageV3 implements EmbedContentResponseOrBuilder

Response message for PredictionService.EmbedContent.

Protobuf type google.cloud.aiplatform.v1beta1.EmbedContentResponse

Static Fields

EMBEDDING_FIELD_NUMBER

public static final int EMBEDDING_FIELD_NUMBER
Field Value
Type Description
int

TRUNCATED_FIELD_NUMBER

public static final int TRUNCATED_FIELD_NUMBER
Field Value
Type Description
int

USAGE_METADATA_FIELD_NUMBER

public static final int USAGE_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static EmbedContentResponse getDefaultInstance()
Returns
Type Description
EmbedContentResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static EmbedContentResponse.Builder newBuilder()
Returns
Type Description
EmbedContentResponse.Builder

newBuilder(EmbedContentResponse prototype)

public static EmbedContentResponse.Builder newBuilder(EmbedContentResponse prototype)
Parameter
Name Description
prototype EmbedContentResponse
Returns
Type Description
EmbedContentResponse.Builder

parseDelimitedFrom(InputStream input)

public static EmbedContentResponse parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static EmbedContentResponse parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static EmbedContentResponse parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static EmbedContentResponse parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static EmbedContentResponse parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static EmbedContentResponse parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static EmbedContentResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
EmbedContentResponse
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<EmbedContentResponse> parser()
Returns
Type Description
Parser<EmbedContentResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public EmbedContentResponse getDefaultInstanceForType()
Returns
Type Description
EmbedContentResponse

getEmbedding()

public EmbedContentResponse.Embedding getEmbedding()

The embedding generated from the input content.

.google.cloud.aiplatform.v1beta1.EmbedContentResponse.Embedding embedding = 1;

Returns
Type Description
EmbedContentResponse.Embedding

The embedding.

getEmbeddingOrBuilder()

public EmbedContentResponse.EmbeddingOrBuilder getEmbeddingOrBuilder()

The embedding generated from the input content.

.google.cloud.aiplatform.v1beta1.EmbedContentResponse.Embedding embedding = 1;

Returns
Type Description
EmbedContentResponse.EmbeddingOrBuilder

getParserForType()

public Parser<EmbedContentResponse> getParserForType()
Returns
Type Description
Parser<EmbedContentResponse>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTruncated()

public boolean getTruncated()

Whether the input content was truncated before generating the embedding.

bool truncated = 4;

Returns
Type Description
boolean

The truncated.

getUsageMetadata()

public UsageMetadata getUsageMetadata()

Metadata about the response(s).

.google.cloud.aiplatform.v1beta1.UsageMetadata usage_metadata = 2;

Returns
Type Description
UsageMetadata

The usageMetadata.

getUsageMetadataOrBuilder()

public UsageMetadataOrBuilder getUsageMetadataOrBuilder()

Metadata about the response(s).

.google.cloud.aiplatform.v1beta1.UsageMetadata usage_metadata = 2;

Returns
Type Description
UsageMetadataOrBuilder

hasEmbedding()

public boolean hasEmbedding()

The embedding generated from the input content.

.google.cloud.aiplatform.v1beta1.EmbedContentResponse.Embedding embedding = 1;

Returns
Type Description
boolean

Whether the embedding field is set.

hasUsageMetadata()

public boolean hasUsageMetadata()

Metadata about the response(s).

.google.cloud.aiplatform.v1beta1.UsageMetadata usage_metadata = 2;

Returns
Type Description
boolean

Whether the usageMetadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public EmbedContentResponse.Builder newBuilderForType()
Returns
Type Description
EmbedContentResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected EmbedContentResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
EmbedContentResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public EmbedContentResponse.Builder toBuilder()
Returns
Type Description
EmbedContentResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException