Class GenerativeSettings.KnowledgeConnectorSettings (0.59.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

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

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

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
Exceptions
Type Description
IOException