Class GenerativeSettings.KnowledgeConnectorSettings.Builder (0.38.0) 

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.v3beta1.GenerativeSettings.KnowledgeConnectorSettings

Inheritance

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

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

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

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.

clearField(Descriptors.FieldDescriptor field)

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
GenerativeSettings.KnowledgeConnectorSettings.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerativeSettings.KnowledgeConnectorSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
GenerativeSettings.KnowledgeConnectorSettings.Builder
Overrides

clone()

public GenerativeSettings.KnowledgeConnectorSettings.Builder clone()
Returns
Type Description
GenerativeSettings.KnowledgeConnectorSettings.Builder
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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerativeSettings.KnowledgeConnectorSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerativeSettings.KnowledgeConnectorSettings.Builder
Overrides

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.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerativeSettings.KnowledgeConnectorSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
GenerativeSettings.KnowledgeConnectorSettings.Builder
Overrides