- 3.84.0 (latest)
- 3.83.0
- 3.82.0
- 3.81.0
- 3.79.0
- 3.77.0
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public static final class RetrieveMemoriesRequest.SimilaritySearchParams.Builder extends GeneratedMessage.Builder<RetrieveMemoriesRequest.SimilaritySearchParams.Builder> implements RetrieveMemoriesRequest.SimilaritySearchParamsOrBuilderParameters for semantic similarity search based retrieval.
Protobuf type
google.cloud.aiplatform.v1beta1.RetrieveMemoriesRequest.SimilaritySearchParams
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > RetrieveMemoriesRequest.SimilaritySearchParams.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public RetrieveMemoriesRequest.SimilaritySearchParams build()| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams |
|
buildPartial()
public RetrieveMemoriesRequest.SimilaritySearchParams buildPartial()| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams |
|
clear()
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clear()| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
|
clearSearchQuery()
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearSearchQuery()Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
This builder for chaining. |
clearTopK()
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder clearTopK()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];
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public RetrieveMemoriesRequest.SimilaritySearchParams getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getSearchQuery()
public String getSearchQuery()Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The searchQuery. |
getSearchQueryBytes()
public ByteString getSearchQueryBytes()Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
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];
| Returns | |
|---|---|
| Type | Description |
int |
The topK. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(RetrieveMemoriesRequest.SimilaritySearchParams other)| Parameter | |
|---|---|
| Name | Description |
other |
RetrieveMemoriesRequest.SimilaritySearchParams |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
|
setSearchQuery(String value)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setSearchQuery(String value)Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe searchQuery to set. |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
This builder for chaining. |
setSearchQueryBytes(ByteString value)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setSearchQueryBytes(ByteString value)Required. Query to use for similarity search retrieval. If provided, then the parent ReasoningEngine must have ReasoningEngineContextSpec.MemoryBankConfig.SimilaritySearchConfig set.
string search_query = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for searchQuery to set. |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
This builder for chaining. |
setTopK(int value)
public RetrieveMemoriesRequest.SimilaritySearchParams.Builder setTopK(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe topK to set. |
| Returns | |
|---|---|
| Type | Description |
RetrieveMemoriesRequest.SimilaritySearchParams.Builder |
This builder for chaining. |