KnowledgeConnectorSettings

The Knowledge Connector settings for this page or flow. This includes information such as the attached Knowledge Bases, and the way to execute fulfillment.

JSON representation
{
  "enabled": boolean,
  "triggerFulfillment": {
    object (Fulfillment)
  },
  "dataStoreConnections": [
    {
      object (DataStoreConnection)
    }
  ],

  // Union field target can be only one of the following:
  "targetPage": string,
  "targetFlow": string
  // End of list of possible types for union field target.
}
Fields
enabled

boolean

Whether Knowledge Connector is enabled or not.

triggerFulfillment

object (Fulfillment)

The fulfillment to be triggered.

When the answers from the Knowledge Connector are selected by Dialogflow, you can utitlize the request scoped parameter $request.knowledge.answers (contains up to the 5 highest confidence answers) and $request.knowledge.questions (contains the corresponding questions) to construct the fulfillment.

dataStoreConnections[]

object (DataStoreConnection)

Optional. List of related data store connections.

Union field target. The target to transition to, either a page in the same host flow (the flow that owns this KnowledgeConnectorSettings), or another flow in the same agent. target can be only one of the following:
targetPage

string

The target page to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>/pages/<PageID>.

targetFlow

string

The target flow to transition to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/flows/<FlowID>.

DataStoreConnection

A data store connection. It represents a data store in Discovery Engine and the type of the contents it contains.

JSON representation
{
  "dataStoreType": enum (DataStoreType),
  "dataStore": string,
  "documentProcessingMode": enum (DocumentProcessingMode)
}
Fields
dataStoreType

enum (DataStoreType)

The type of the connected data store.

dataStore

string

The full name of the referenced data store. Formats: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore} projects/{project}/locations/{location}/dataStores/{dataStore}

documentProcessingMode

enum (DocumentProcessingMode)

The document processing mode for the data store connection. Should only be set for PUBLIC_WEB and UNSTRUCTURED data stores. If not set it is considered as DOCUMENTS, as this is the legacy mode.

DataStoreType

Type of a data store. Determines how search is performed in the data store.

Enums
DATA_STORE_TYPE_UNSPECIFIED Not specified. This value indicates that the data store type is not specified, so it will not be used during search.
PUBLIC_WEB A data store that contains public web content.
UNSTRUCTURED A data store that contains unstructured private data.
STRUCTURED A data store that contains structured data (for example FAQ).

DocumentProcessingMode

The document processing mode of the data store.

Enums
DOCUMENT_PROCESSING_MODE_UNSPECIFIED Not specified. This should be set for STRUCTURED type data stores. Due to legacy reasons this is considered as DOCUMENTS for STRUCTURED and PUBLIC_WEB data stores.
DOCUMENTS Documents are processed as documents.
CHUNKS Documents are converted to chunks.