Package com.google.cloud.dialogflow.cx.v3beta1

Class GenerativeSettings.KnowledgeConnectorSettings.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

com.google.cloud.dialogflow.cx.v3beta1.GenerativeSettings.KnowledgeConnectorSettings.Builder

All Implemented Interfaces:

GenerativeSettings.KnowledgeConnectorSettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GenerativeSettings.KnowledgeConnectorSettings

public static final class GenerativeSettings.KnowledgeConnectorSettings.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>
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.v3beta1.GenerativeSettings.KnowledgeConnectorSettings

Method Summary

Modifier and Type	Method	Description
GenerativeSettings.KnowledgeConnectorSettings	build()
GenerativeSettings.KnowledgeConnectorSettings	buildPartial()
GenerativeSettings.KnowledgeConnectorSettings.Builder	clear()
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearAgent()	Name of the virtual agent.
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearAgentIdentity()	Identity of the agent, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearAgentScope()	Agent scope, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearBusiness()	Name of the company, organization or other entity that the agent represents.
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearBusinessDescription()	Company description, used for LLM prompt, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	clearDisableDataStoreFallback()	Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer).
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.
GenerativeSettings.KnowledgeConnectorSettings	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDisableDataStoreFallback()	Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer).
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
GenerativeSettings.KnowledgeConnectorSettings.Builder	mergeFrom(GenerativeSettings.KnowledgeConnectorSettings other)
GenerativeSettings.KnowledgeConnectorSettings.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerativeSettings.KnowledgeConnectorSettings.Builder	mergeFrom(com.google.protobuf.Message other)
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgent(String value)	Name of the virtual agent.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgentBytes(com.google.protobuf.ByteString value)	Name of the virtual agent.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgentIdentity(String value)	Identity of the agent, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgentIdentityBytes(com.google.protobuf.ByteString value)	Identity of the agent, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgentScope(String value)	Agent scope, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setAgentScopeBytes(com.google.protobuf.ByteString value)	Agent scope, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setBusiness(String value)	Name of the company, organization or other entity that the agent represents.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setBusinessBytes(com.google.protobuf.ByteString value)	Name of the company, organization or other entity that the agent represents.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setBusinessDescription(String value)	Company description, used for LLM prompt, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setBusinessDescriptionBytes(com.google.protobuf.ByteString value)	Company description, used for LLM prompt, e.g.
GenerativeSettings.KnowledgeConnectorSettings.Builder	setDisableDataStoreFallback(boolean value)	Whether to disable fallback to Data Store search results (in case the LLM couldn't pick a proper answer).

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

clear

public GenerativeSettings.KnowledgeConnectorSettings.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

getDefaultInstanceForType

public GenerativeSettings.KnowledgeConnectorSettings getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GenerativeSettings.KnowledgeConnectorSettings build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerativeSettings.KnowledgeConnectorSettings buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public GenerativeSettings.KnowledgeConnectorSettings.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

mergeFrom

public GenerativeSettings.KnowledgeConnectorSettings.Builder mergeFrom(GenerativeSettings.KnowledgeConnectorSettings other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerativeSettings.KnowledgeConnectorSettings.Builder>

Throws:

IOException

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.

setBusiness

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusiness(String value)

 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;

Parameters:

value - The business to set.

Returns:

This builder for chaining.

clearBusiness

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearBusiness()

 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:

This builder for chaining.

setBusinessBytes

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusinessBytes(com.google.protobuf.ByteString value)

 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;

Parameters:

value - The bytes for business to set.

Returns:

This builder for chaining.

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.

setAgent

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgent(String value)

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

string agent = 2;

Parameters:

value - The agent to set.

Returns:

This builder for chaining.

clearAgent

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearAgent()

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

string agent = 2;

Returns:

This builder for chaining.

setAgentBytes

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentBytes(com.google.protobuf.ByteString value)

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

string agent = 2;

Parameters:

value - The bytes for agent to set.

Returns:

This builder for chaining.

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.

setAgentIdentity

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentIdentity(String value)

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

string agent_identity = 3;

Parameters:

value - The agentIdentity to set.

Returns:

This builder for chaining.

clearAgentIdentity

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearAgentIdentity()

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

string agent_identity = 3;

Returns:

This builder for chaining.

setAgentIdentityBytes

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentIdentityBytes(com.google.protobuf.ByteString value)

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

string agent_identity = 3;

Parameters:

value - The bytes for agentIdentity to set.

Returns:

This builder for chaining.

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.

setBusinessDescription

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusinessDescription(String value)

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

string business_description = 4;

Parameters:

value - The businessDescription to set.

Returns:

This builder for chaining.

clearBusinessDescription

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearBusinessDescription()

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

string business_description = 4;

Returns:

This builder for chaining.

setBusinessDescriptionBytes

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusinessDescriptionBytes(com.google.protobuf.ByteString value)

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

string business_description = 4;

Parameters:

value - The bytes for businessDescription to set.

Returns:

This builder for chaining.

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.

setAgentScope

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentScope(String value)

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

string agent_scope = 5;

Parameters:

value - The agentScope to set.

Returns:

This builder for chaining.

clearAgentScope

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearAgentScope()

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

string agent_scope = 5;

Returns:

This builder for chaining.

setAgentScopeBytes

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentScopeBytes(com.google.protobuf.ByteString value)

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

string agent_scope = 5;

Parameters:

value - The bytes for agentScope to set.

Returns:

This builder for chaining.

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.

setDisableDataStoreFallback

public GenerativeSettings.KnowledgeConnectorSettings.Builder setDisableDataStoreFallback(boolean value)

 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;

Parameters:

value - The disableDataStoreFallback to set.

Returns:

This builder for chaining.

clearDisableDataStoreFallback

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearDisableDataStoreFallback()

 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:

This builder for chaining.