Class GenerativeSettings.KnowledgeConnectorSettings.Builder (0.60.0)

Version 0.60.0

• 0.65.0 (latest)
• 0.64.0
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

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

Inheritance

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

Implements

GenerativeSettings.KnowledgeConnectorSettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public GenerativeSettings.KnowledgeConnectorSettings build()

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings

buildPartial()

public GenerativeSettings.KnowledgeConnectorSettings buildPartial()

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings

clear()

public GenerativeSettings.KnowledgeConnectorSettings.Builder clear()

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAgent()

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearAgent()

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

string agent = 2;

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	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
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	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
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	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
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	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
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	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
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public GenerativeSettings.KnowledgeConnectorSettings.Builder clone()

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GenerativeSettings.KnowledgeConnectorSettings other)

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

Parameter
Name	Description
other	GenerativeSettings.KnowledgeConnectorSettings

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerativeSettings.KnowledgeConnectorSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GenerativeSettings.KnowledgeConnectorSettings.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerativeSettings.KnowledgeConnectorSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAgent(String value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgent(String value)

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

string agent = 2;

Parameter
Name	Description
value	String The agent to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setAgentBytes(ByteString value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentBytes(ByteString value)

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

string agent = 2;

Parameter
Name	Description
value	ByteString The bytes for agent to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setAgentIdentity(String value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentIdentity(String value)

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

string agent_identity = 3;

Parameter
Name	Description
value	String The agentIdentity to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setAgentIdentityBytes(ByteString value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentIdentityBytes(ByteString value)

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

string agent_identity = 3;

Parameter
Name	Description
value	ByteString The bytes for agentIdentity to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setAgentScope(String value)

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;

Parameter
Name	Description
value	String The agentScope to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setAgentScopeBytes(ByteString value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setAgentScopeBytes(ByteString value)

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

string agent_scope = 5;

Parameter
Name	Description
value	ByteString The bytes for agentScope to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setBusiness(String value)

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;

Parameter
Name	Description
value	String The business to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setBusinessBytes(ByteString value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusinessBytes(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;

Parameter
Name	Description
value	ByteString The bytes for business to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setBusinessDescription(String value)

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;

Parameter
Name	Description
value	String The businessDescription to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setBusinessDescriptionBytes(ByteString value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setBusinessDescriptionBytes(ByteString value)

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

string business_description = 4;

Parameter
Name	Description
value	ByteString The bytes for businessDescription to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setDisableDataStoreFallback(boolean value)

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;

Parameter
Name	Description
value	boolean The disableDataStoreFallback to set.

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerativeSettings.KnowledgeConnectorSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerativeSettings.KnowledgeConnectorSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerativeSettings.KnowledgeConnectorSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)