Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class KnowledgeConnectorSettings.
Settings for knowledge connector. These parameters are used for LLM prompt like "You are
Generated from protobuf message google.cloud.dialogflow.cx.v3.GenerativeSettings.KnowledgeConnectorSettings
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3 \ GenerativeSettingsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ business |
string
Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. |
↳ agent |
string
Name of the virtual agent. Used for LLM prompt. Can be left empty. |
↳ agent_identity |
string
Identity of the agent, e.g. "virtual agent", "AI assistant". |
↳ business_description |
string
Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans". |
↳ agent_scope |
string
Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner". |
↳ disable_data_store_fallback |
bool
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. |
getBusiness
Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
| Returns | |
|---|---|
| Type | Description |
string |
|
setBusiness
Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgent
Name of the virtual agent. Used for LLM prompt. Can be left empty.
| Returns | |
|---|---|
| Type | Description |
string |
|
setAgent
Name of the virtual agent. Used for LLM prompt. Can be left empty.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgentIdentity
Identity of the agent, e.g. "virtual agent", "AI assistant".
| Returns | |
|---|---|
| Type | Description |
string |
|
setAgentIdentity
Identity of the agent, e.g. "virtual agent", "AI assistant".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBusinessDescription
Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
| Returns | |
|---|---|
| Type | Description |
string |
|
setBusinessDescription
Company description, used for LLM prompt, e.g. "a family company selling freshly roasted coffee beans".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAgentScope
Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
| Returns | |
|---|---|
| Type | Description |
string |
|
setAgentScope
Agent scope, e.g. "Example company website", "internal Example company website for employees", "manual of car owner".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setDisableDataStoreFallback
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|