Class SearchExamplesResponse.SimilarExample (3.64.0)

public static final class SearchExamplesResponse.SimilarExample extends GeneratedMessageV3 implements SearchExamplesResponse.SimilarExampleOrBuilder

The result of the similar example.

Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesResponse.SimilarExample

Inheritance

Object > AbstractMessageLite > AbstractMessage > GeneratedMessageV3 > SearchExamplesResponse.SimilarExample

Static Fields

EXAMPLE_FIELD_NUMBER

public static final int EXAMPLE_FIELD_NUMBER
Field Value
Type Description
int

SIMILARITY_SCORE_FIELD_NUMBER

public static final int SIMILARITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchExamplesResponse.SimilarExample getDefaultInstance()
Returns
Type Description
SearchExamplesResponse.SimilarExample

getDescriptor()

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

newBuilder()

public static SearchExamplesResponse.SimilarExample.Builder newBuilder()
Returns
Type Description
SearchExamplesResponse.SimilarExample.Builder

newBuilder(SearchExamplesResponse.SimilarExample prototype)

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

parseDelimitedFrom(InputStream input)

public static SearchExamplesResponse.SimilarExample parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchExamplesResponse.SimilarExample
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SearchExamplesResponse.SimilarExample parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchExamplesResponse.SimilarExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static SearchExamplesResponse.SimilarExample parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchExamplesResponse.SimilarExample
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static SearchExamplesResponse.SimilarExample parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchExamplesResponse.SimilarExample
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static SearchExamplesResponse.SimilarExample parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchExamplesResponse.SimilarExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser.SimilarExample> parser()
Returns
Type Description
Parser<SimilarExample>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchExamplesResponse.SimilarExample getDefaultInstanceForType()
Returns
Type Description
SearchExamplesResponse.SimilarExample

getExample()

public Example getExample()

The example that is similar to the searched query.

.google.cloud.aiplatform.v1beta1.Example example = 1;

Returns
Type Description
Example

The example.

getExampleOrBuilder()

public ExampleOrBuilder getExampleOrBuilder()

The example that is similar to the searched query.

.google.cloud.aiplatform.v1beta1.Example example = 1;

Returns
Type Description
ExampleOrBuilder

getParserForType()

public Parser.SimilarExample> getParserForType()
Returns
Type Description
Parser<SimilarExample>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSimilarityScore()

public float getSimilarityScore()

The similarity score of this example.

float similarity_score = 2;

Returns
Type Description
float

The similarityScore.

hasExample()

public boolean hasExample()

The example that is similar to the searched query.

.google.cloud.aiplatform.v1beta1.Example example = 1;

Returns
Type Description
boolean

Whether the example 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 SearchExamplesResponse.SimilarExample.Builder newBuilderForType()
Returns
Type Description
SearchExamplesResponse.SimilarExample.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SearchExamplesResponse.SimilarExample.Builder toBuilder()
Returns
Type Description
SearchExamplesResponse.SimilarExample.Builder

writeTo(CodedOutputStream output)

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