Class MemoryBankCustomizationConfig (3.100.0)

public final class MemoryBankCustomizationConfig extends GeneratedMessage implements MemoryBankCustomizationConfigOrBuilder

Represents configuration for organizing natural language memories for a particular scope.

Protobuf type google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > MemoryBankCustomizationConfig

Static Fields

CONSOLIDATION_CONFIG_FIELD_NUMBER

public static final int CONSOLIDATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

DISABLE_NATURAL_LANGUAGE_MEMORIES_FIELD_NUMBER

public static final int DISABLE_NATURAL_LANGUAGE_MEMORIES_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_THIRD_PERSON_MEMORIES_FIELD_NUMBER

public static final int ENABLE_THIRD_PERSON_MEMORIES_FIELD_NUMBER
Field Value
Type Description
int

GENERATE_MEMORIES_EXAMPLES_FIELD_NUMBER

public static final int GENERATE_MEMORIES_EXAMPLES_FIELD_NUMBER
Field Value
Type Description
int

MEMORY_TOPICS_FIELD_NUMBER

public static final int MEMORY_TOPICS_FIELD_NUMBER
Field Value
Type Description
int

SCOPE_KEYS_FIELD_NUMBER

public static final int SCOPE_KEYS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static MemoryBankCustomizationConfig getDefaultInstance()
Returns
Type Description
MemoryBankCustomizationConfig

getDescriptor()

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

newBuilder()

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

newBuilder(MemoryBankCustomizationConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getConsolidationConfig()

public MemoryBankCustomizationConfig.ConsolidationConfig getConsolidationConfig()

Optional. Represents configuration for customizing how memories are consolidated together.

.google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.ConsolidationConfig consolidation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MemoryBankCustomizationConfig.ConsolidationConfig

The consolidationConfig.

getConsolidationConfigOrBuilder()

public MemoryBankCustomizationConfig.ConsolidationConfigOrBuilder getConsolidationConfigOrBuilder()

Optional. Represents configuration for customizing how memories are consolidated together.

.google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.ConsolidationConfig consolidation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
MemoryBankCustomizationConfig.ConsolidationConfigOrBuilder

getDefaultInstanceForType()

public MemoryBankCustomizationConfig getDefaultInstanceForType()
Returns
Type Description
MemoryBankCustomizationConfig

getDisableNaturalLanguageMemories()

public boolean getDisableNaturalLanguageMemories()

Optional. Indicates whether natural language memory generation should be disabled for all requests. By default, natural language memory generation is enabled. Set this to true when you only want to generate structured memories.

bool disable_natural_language_memories = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableNaturalLanguageMemories.

getEnableThirdPersonMemories()

public boolean getEnableThirdPersonMemories()

Optional. Indicates whether the memories will be generated in the third person (i.e. "The user generates memories with Memory Bank."). By default, the memories will be generated in the first person (i.e. "I generate memories with Memory Bank.")

bool enable_third_person_memories = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableThirdPersonMemories.

getGenerateMemoriesExamples(int index)

public MemoryBankCustomizationConfig.GenerateMemoriesExample getGenerateMemoriesExamples(int index)

Optional. Provides examples of how to generate memories for a particular scope.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExample generate_memories_examples = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryBankCustomizationConfig.GenerateMemoriesExample

getGenerateMemoriesExamplesCount()

public int getGenerateMemoriesExamplesCount()

Optional. Provides examples of how to generate memories for a particular scope.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExample generate_memories_examples = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getGenerateMemoriesExamplesList()

public List<MemoryBankCustomizationConfig.GenerateMemoriesExample> getGenerateMemoriesExamplesList()

Optional. Provides examples of how to generate memories for a particular scope.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExample generate_memories_examples = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<GenerateMemoriesExample>

getGenerateMemoriesExamplesOrBuilder(int index)

public MemoryBankCustomizationConfig.GenerateMemoriesExampleOrBuilder getGenerateMemoriesExamplesOrBuilder(int index)

Optional. Provides examples of how to generate memories for a particular scope.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExample generate_memories_examples = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryBankCustomizationConfig.GenerateMemoriesExampleOrBuilder

getGenerateMemoriesExamplesOrBuilderList()

public List<? extends MemoryBankCustomizationConfig.GenerateMemoriesExampleOrBuilder> getGenerateMemoriesExamplesOrBuilderList()

Optional. Provides examples of how to generate memories for a particular scope.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExample generate_memories_examples = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.GenerateMemoriesExampleOrBuilder>

getMemoryTopics(int index)

public MemoryBankCustomizationConfig.MemoryTopic getMemoryTopics(int index)

Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopic memory_topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryBankCustomizationConfig.MemoryTopic

getMemoryTopicsCount()

public int getMemoryTopicsCount()

Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopic memory_topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getMemoryTopicsList()

public List<MemoryBankCustomizationConfig.MemoryTopic> getMemoryTopicsList()

Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopic memory_topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<MemoryTopic>

getMemoryTopicsOrBuilder(int index)

public MemoryBankCustomizationConfig.MemoryTopicOrBuilder getMemoryTopicsOrBuilder(int index)

Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopic memory_topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
MemoryBankCustomizationConfig.MemoryTopicOrBuilder

getMemoryTopicsOrBuilderList()

public List<? extends MemoryBankCustomizationConfig.MemoryTopicOrBuilder> getMemoryTopicsOrBuilderList()

Optional. Represents topics of information that should be extracted from conversations and stored as memories. If not set, then Memory Bank's default topics will be used.

repeated .google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopic memory_topics = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.MemoryTopicOrBuilder>

getParserForType()

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

getScopeKeys(int index)

public String getScopeKeys(int index)

Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.

repeated string scope_keys = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The scopeKeys at the given index.

getScopeKeysBytes(int index)

public ByteString getScopeKeysBytes(int index)

Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.

repeated string scope_keys = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the scopeKeys at the given index.

getScopeKeysCount()

public int getScopeKeysCount()

Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.

repeated string scope_keys = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of scopeKeys.

getScopeKeysList()

public ProtocolStringList getScopeKeysList()

Optional. Represents the scope keys (i.e. 'user_id') for which to use this config. A request's scope must include all of the provided keys for the config to be used (order does not matter). If empty, then the config will be used for all requests that do not have a more specific config. Only one default config is allowed per Memory Bank.

repeated string scope_keys = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the scopeKeys.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConsolidationConfig()

public boolean hasConsolidationConfig()

Optional. Represents configuration for customizing how memories are consolidated together.

.google.cloud.aiplatform.v1beta1.MemoryBankCustomizationConfig.ConsolidationConfig consolidation_config = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the consolidationConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected MemoryBankCustomizationConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
MemoryBankCustomizationConfig.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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