Package com.google.cloud.aiplatform.v1beta1

Class RetrieveMemoriesRequest.SimilaritySearchParams

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams

All Implemented Interfaces:

RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

RetrieveMemoriesRequest

public static final class RetrieveMemoriesRequest.SimilaritySearchParams
extends com.google.protobuf.GeneratedMessage
implements RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

 Parameters for semantic similarity search based retrieval.
 

Protobuf type google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	RetrieveMemoriesRequest.SimilaritySearchParams.Builder	Parameters for semantic similarity search based retrieval.

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 extends Object>, 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	Description
static final int	SEARCH_QUERY_FIELD_NUMBER
static final int	TOP_K_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	Description
boolean	equals(Object obj)
static RetrieveMemoriesRequest.SimilaritySearchParams	getDefaultInstance()
RetrieveMemoriesRequest.SimilaritySearchParams	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<RetrieveMemoriesRequest.SimilaritySearchParams>	getParserForType()
String	getSearchQuery()	Required.
com.google.protobuf.ByteString	getSearchQueryBytes()	Required.
int	getSerializedSize()
int	getTopK()	Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static RetrieveMemoriesRequest.SimilaritySearchParams.Builder	newBuilder()
static RetrieveMemoriesRequest.SimilaritySearchParams.Builder	newBuilder(RetrieveMemoriesRequest.SimilaritySearchParams prototype)
RetrieveMemoriesRequest.SimilaritySearchParams.Builder	newBuilderForType()
protected RetrieveMemoriesRequest.SimilaritySearchParams.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseDelimitedFrom(InputStream input)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(byte[] data)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(com.google.protobuf.ByteString data)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(com.google.protobuf.CodedInputStream input)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(InputStream input)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(ByteBuffer data)
static RetrieveMemoriesRequest.SimilaritySearchParams	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RetrieveMemoriesRequest.SimilaritySearchParams>	parser()
RetrieveMemoriesRequest.SimilaritySearchParams.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.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

SEARCH_QUERY_FIELD_NUMBER

public static final int SEARCH_QUERY_FIELD_NUMBER

See Also:

• Constant Field Values

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

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

getSearchQuery

public String getSearchQuery()

 Required. Query to use for similarity search retrieval. If provided, then
 the parent ReasoningEngine must have
 [ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
 

string search_query = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSearchQuery in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

Returns:

The searchQuery.

getSearchQueryBytes

public com.google.protobuf.ByteString getSearchQueryBytes()

 Required. Query to use for similarity search retrieval. If provided, then
 the parent ReasoningEngine must have
 [ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig][google.cloud.aiplatform.v1beta1.ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig]
 set.
 

string search_query = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getSearchQueryBytes in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

Returns:

The bytes for searchQuery.

getTopK

public int getTopK()

 Optional. The maximum number of memories to return.
 The service may return fewer than this value. If unspecified, at most 3
 memories will be returned. The maximum value is 100; values above 100
 will be coerced to 100.
 

int32 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTopK in interface RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilder

Returns:

The topK.

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 RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(ByteBuffer data)
                                                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RetrieveMemoriesRequest.SimilaritySearchParams parseFrom(InputStream input)
                                                                throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RetrieveMemoriesRequest.SimilaritySearchParams parseDelimitedFrom(InputStream input)
                                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilder()

newBuilder

public static RetrieveMemoriesRequest.SimilaritySearchParams.Builder newBuilder(RetrieveMemoriesRequest.SimilaritySearchParams prototype)

toBuilder

public RetrieveMemoriesRequest.SimilaritySearchParams.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<RetrieveMemoriesRequest.SimilaritySearchParams> 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 RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder