Class GenerativeSettings.KnowledgeConnectorSettings (0.63.0)

public static final class GenerativeSettings.KnowledgeConnectorSettings extends 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerativeSettings.KnowledgeConnectorSettings

Implements

GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AGENT_FIELD_NUMBER

public static final int AGENT_FIELD_NUMBER

Field Value
Type	Description
`int`

AGENT_IDENTITY_FIELD_NUMBER

public static final int AGENT_IDENTITY_FIELD_NUMBER

Field Value
Type	Description
`int`

AGENT_SCOPE_FIELD_NUMBER

public static final int AGENT_SCOPE_FIELD_NUMBER

Field Value
Type	Description
`int`

BUSINESS_DESCRIPTION_FIELD_NUMBER

public static final int BUSINESS_DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

BUSINESS_FIELD_NUMBER

public static final int BUSINESS_FIELD_NUMBER

Field Value
Type	Description
`int`

DISABLE_DATA_STORE_FALLBACK_FIELD_NUMBER

public static final int DISABLE_DATA_STORE_FALLBACK_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static GenerativeSettings.KnowledgeConnectorSettings getDefaultInstance()

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilder()

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings.Builder`

newBuilder(GenerativeSettings.KnowledgeConnectorSettings prototype)

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

Parameter
Name	Description
`prototype`	`GenerativeSettings.KnowledgeConnectorSettings`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings.Builder`

parseDelimitedFrom(InputStream input)

public static GenerativeSettings.KnowledgeConnectorSettings parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerativeSettings.KnowledgeConnectorSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<GenerativeSettings.KnowledgeConnectorSettings> parser()

Returns
Type	Description
`Parser<KnowledgeConnectorSettings>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAgent()

public String getAgent()

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

string agent = 2;

Returns
Type	Description
`String`	The agent.

getAgentBytes()

public ByteString getAgentBytes()

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

string agent = 2;

Returns
Type	Description
`ByteString`	The bytes for agent.

getAgentIdentity()

public String getAgentIdentity()

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

string agent_identity = 3;

Returns
Type	Description
`String`	The agentIdentity.

getAgentIdentityBytes()

public ByteString getAgentIdentityBytes()

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

string agent_identity = 3;

Returns
Type	Description
`ByteString`	The bytes for agentIdentity.

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;

Returns
Type	Description
`String`	The agentScope.

getAgentScopeBytes()

public ByteString getAgentScopeBytes()

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

string agent_scope = 5;

Returns
Type	Description
`ByteString`	The bytes for agentScope.

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;

Returns
Type	Description
`String`	The business.

getBusinessBytes()

public 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;

Returns
Type	Description
`ByteString`	The bytes for business.

getBusinessDescription()

public String getBusinessDescription()

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

string business_description = 4;

Returns
Type	Description
`String`	The businessDescription.

getBusinessDescriptionBytes()

public ByteString getBusinessDescriptionBytes()

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

string business_description = 4;

Returns
Type	Description
`ByteString`	The bytes for businessDescription.

getDefaultInstanceForType()

public GenerativeSettings.KnowledgeConnectorSettings getDefaultInstanceForType()

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings`

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;

Returns
Type	Description
`boolean`	The disableDataStoreFallback.

getParserForType()

public Parser<GenerativeSettings.KnowledgeConnectorSettings> getParserForType()

Returns
Type	Description
`Parser<KnowledgeConnectorSettings>`

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilderForType()

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings.Builder`

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GenerativeSettings.KnowledgeConnectorSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings.Builder`

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
`unused`	`UnusedPrivateParameter`

Returns
Type	Description
`Object`

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public GenerativeSettings.KnowledgeConnectorSettings.Builder toBuilder()

Returns
Type	Description
`GenerativeSettings.KnowledgeConnectorSettings.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`