Connectors & Indexing

View as Markdown

Connectors bring approved external content into OpenCore knowledge. Admins can manage all connectors and document sets. Curators can manage them for groups for which they are a curator, and Global Curators can manage them for groups of which they are a member. Agents use only the indexed document sets attached to them.

Concepts

ConceptMeaning
ConnectorA saved connection to one content source and its indexing scope.
CredentialProtected authentication material that gives a connector access to its source.
Index AttemptOne recorded run that discovers, reads, and indexes content for a connector.
Document SetA named collection of indexed documents that can be selected for an Agent.

Standard mode requirement

Lite mode has no vector database. It cannot index documents, so connectors, document sets, and index settings require Standard mode.

Use Standard mode before adding a connector. Verify that the deployment has the required storage and that the source’s administrator has approved the intended access scope.

Add a connector

  1. Sign in as an Admin or Curator and open Documents & Knowledge.
  2. Select the approved source, then choose an authentication method and credential available within your permitted scope.
  3. Limit the indexing scope to the content the deployment is authorized to use.
  4. Save the connector and start an index attempt.

Do not place credentials in Agent instructions, chat messages, source control, or shared documents. Keep each connector focused on one approved source and access boundary.

For ordinary connectors and document sets, a Curator’s editable scope is limited to groups for which they are a curator; a Global Curator uses the same controls for groups of which they are a member. Google Drive is a special credential flow: an Admin creates and maintains the Google credential and selects or associates it with the connector, as described in the Google Drive guides.

Monitor indexing

Review each index attempt after it runs. Confirm the attempt completed, inspect any reported errors, and verify that the expected documents are available before relying on them in an Agent.

An index attempt records a run; it is not a standing guarantee that the source stays reachable or that later source changes have been indexed. Run a new attempt after changing the connector scope, credential, or relevant source content.

Organize document sets

Group indexed documents into document sets that match a clear access and retrieval purpose. Attach only the required document sets to an Agent, and review the set again when its source scope or intended audience changes.

Document sets organize indexed content; they do not grant access to a source or replace the source’s own permissions. Remove a document set from an Agent when it is no longer needed.

Index settings

Only an Admin changes deployment-wide Index Settings. For connector-level scope and update cadence, use settings that match the approved source and start with a small, representative scope. Verify the indexed results, then expand only when the content owner and deployment policy allow it.

Changing index settings can require a new index attempt before the updated results are available. Record why a scope or setting was chosen so that another Admin can review it later.

Connector guides

Choose the guide for the approved source you need to index: