com.google.cloud.dialogflow.cx.v3

Class GenerativeSettings.KnowledgeConnectorSettings

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.dialogflow.cx.v3.GenerativeSettings.KnowledgeConnectorSettings

All Implemented Interfaces:

GenerativeSettings.KnowledgeConnectorSettingsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

GenerativeSettings

public static final class GenerativeSettings.KnowledgeConnectorSettings
extends com.google.protobuf.GeneratedMessageV3
implements GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

 Settings for knowledge connector. These parameters are used for LLM prompt
 like "You are <agent>. You are a helpful and verbose <agent_identity> at
 <business>, <business_description>. Your task is to help humans on
 <agent_scope>".
 

Protobuf type google.cloud.dialogflow.cx.v3.GenerativeSettings.KnowledgeConnectorSettings

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerativeSettings.KnowledgeConnectorSettings.Builder Settings for knowledge connector.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AGENT_FIELD_NUMBER
static int	AGENT_IDENTITY_FIELD_NUMBER
static int	AGENT_SCOPE_FIELD_NUMBER
static int	BUSINESS_DESCRIPTION_FIELD_NUMBER
static int	BUSINESS_FIELD_NUMBER
static int	DISABLE_DATA_STORE_FALLBACK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
String	getAgent() Name of the virtual agent.
com.google.protobuf.ByteString	getAgentBytes() Name of the virtual agent.
String	getAgentIdentity() Identity of the agent, e.g.
com.google.protobuf.ByteString	getAgentIdentityBytes() Identity of the agent, e.g.
String	getAgentScope() Agent scope, e.g.
com.google.protobuf.ByteString	getAgentScopeBytes() Agent scope, e.g.
String	getBusiness() Name of the company, organization or other entity that the agent represents.
com.google.protobuf.ByteString	getBusinessBytes() Name of the company, organization or other entity that the agent represents.
String	getBusinessDescription() Company description, used for LLM prompt, e.g.
com.google.protobuf.ByteString	getBusinessDescriptionBytes() Company description, used for LLM prompt, e.g.
static GenerativeSettings.KnowledgeConnectorSettings	getDefaultInstance()
GenerativeSettings.KnowledgeConnectorSettings	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDisableDataStoreFallback() Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer).
com.google.protobuf.Parser<GenerativeSettings.KnowledgeConnectorSettings>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerativeSettings.KnowledgeConnectorSettings.Builder	newBuilder()
static GenerativeSettings.KnowledgeConnectorSettings.Builder	newBuilder(GenerativeSettings.KnowledgeConnectorSettings prototype)
GenerativeSettings.KnowledgeConnectorSettings.Builder	newBuilderForType()
protected GenerativeSettings.KnowledgeConnectorSettings.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerativeSettings.KnowledgeConnectorSettings	parseDelimitedFrom(InputStream input)
static GenerativeSettings.KnowledgeConnectorSettings	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(byte[] data)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(ByteBuffer data)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(com.google.protobuf.ByteString data)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(InputStream input)
static GenerativeSettings.KnowledgeConnectorSettings	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerativeSettings.KnowledgeConnectorSettings>	parser()
GenerativeSettings.KnowledgeConnectorSettings.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

BUSINESS_FIELD_NUMBER

public static final int BUSINESS_FIELD_NUMBER

See Also:

Constant Field Values

AGENT_FIELD_NUMBER

public static final int AGENT_FIELD_NUMBER

See Also:

Constant Field Values

AGENT_IDENTITY_FIELD_NUMBER

public static final int AGENT_IDENTITY_FIELD_NUMBER

See Also:

Constant Field Values

BUSINESS_DESCRIPTION_FIELD_NUMBER

public static final int BUSINESS_DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

AGENT_SCOPE_FIELD_NUMBER

public static final int AGENT_SCOPE_FIELD_NUMBER

See Also:

Constant Field Values

DISABLE_DATA_STORE_FALLBACK_FIELD_NUMBER

public static final int DISABLE_DATA_STORE_FALLBACK_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getBusiness

public String getBusiness()

 Name of the company, organization or other entity that the agent
 represents. Used for knowledge connector LLM prompt and for knowledge
 search.
 

string business = 1;

Specified by:

getBusiness in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The business.

getBusinessBytes

public com.google.protobuf.ByteString getBusinessBytes()

 Name of the company, organization or other entity that the agent
 represents. Used for knowledge connector LLM prompt and for knowledge
 search.
 

string business = 1;

Specified by:

getBusinessBytes in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The bytes for business.

getAgent

public String getAgent()

 Name of the virtual agent. Used for LLM prompt. Can be left empty.
 

string agent = 2;

Specified by:

getAgent in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The agent.

getAgentBytes

public com.google.protobuf.ByteString getAgentBytes()

 Name of the virtual agent. Used for LLM prompt. Can be left empty.
 

string agent = 2;

Specified by:

getAgentBytes in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The bytes for agent.

getAgentIdentity

public String getAgentIdentity()

 Identity of the agent, e.g. "virtual agent", "AI assistant".
 

string agent_identity = 3;

Specified by:

getAgentIdentity in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The agentIdentity.

getAgentIdentityBytes

public com.google.protobuf.ByteString getAgentIdentityBytes()

 Identity of the agent, e.g. "virtual agent", "AI assistant".
 

string agent_identity = 3;

Specified by:

getAgentIdentityBytes in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The bytes for agentIdentity.

getBusinessDescription

public String getBusinessDescription()

 Company description, used for LLM prompt, e.g. "a family company selling
 freshly roasted coffee beans".
 

string business_description = 4;

Specified by:

getBusinessDescription in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The businessDescription.

getBusinessDescriptionBytes

public com.google.protobuf.ByteString getBusinessDescriptionBytes()

 Company description, used for LLM prompt, e.g. "a family company selling
 freshly roasted coffee beans".
 

string business_description = 4;

Specified by:

getBusinessDescriptionBytes in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The bytes for businessDescription.

getAgentScope

public String getAgentScope()

 Agent scope, e.g. "Example company website", "internal Example
 company website for employees", "manual of car owner".
 

string agent_scope = 5;

Specified by:

getAgentScope in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The agentScope.

getAgentScopeBytes

public com.google.protobuf.ByteString getAgentScopeBytes()

 Agent scope, e.g. "Example company website", "internal Example
 company website for employees", "manual of car owner".
 

string agent_scope = 5;

Specified by:

getAgentScopeBytes in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The bytes for agentScope.

getDisableDataStoreFallback

public boolean getDisableDataStoreFallback()

 Whether to disable fallback to Data Store search results (in case the LLM
 couldn't pick a proper answer). Per default the feature is enabled.
 

bool disable_data_store_fallback = 8;

Specified by:

getDisableDataStoreFallback in interface GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Returns:

The disableDataStoreFallback.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(com.google.protobuf.ByteString data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(byte[] data)
                                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(InputStream input)
                                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static GenerativeSettings.KnowledgeConnectorSettings parseDelimitedFrom(InputStream input)
                                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(com.google.protobuf.CodedInputStream input)
                                                               throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilder()

newBuilder

public static GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilder(GenerativeSettings.KnowledgeConnectorSettings prototype)

toBuilder

public GenerativeSettings.KnowledgeConnectorSettings.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerativeSettings.KnowledgeConnectorSettings getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerativeSettings.KnowledgeConnectorSettings> parser()

getParserForType

public com.google.protobuf.Parser<GenerativeSettings.KnowledgeConnectorSettings> 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.GeneratedMessageV3

getDefaultInstanceForType

public GenerativeSettings.KnowledgeConnectorSettings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder