PIpipeshub-ai
Knowledge Base

Reindex record group

Changed on

Trigger reindexing for all records in a record group.

Overview:

Batch reindex operation for a connector's container (a drive, a space, a channel, a crawled site). Record groups are written by connector syncs only: a knowledge base id or a knowledge base folder id is not a record group and is answered 404 (reindex those with POST /knowledgeBase/reindex/record/{recordId} and a depth).

Status filters:

Optional statusFilters limit which child records are queued (e.g. failed-only or manual-indexing). Any string is accepted.

Access: the caller needs access to the record group (an organization-wide connector gives it to every member; a personal one only to its owner); without it the answer is 403. A record group of a disabled connector is refused with 409.

Request: only depth and statusFilters are read; other body fields (force included) and any query parameter are ignored. The body is optional.

post/knowledgeBase/reindex/record-group/{recordGroupId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/reindex/record-group/{recordGroupId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:write

Path parameters

recordGroupIdstring required

Record group ID (from a connector sync; not a knowledge base or folder id)

Request body

depthinteger

Depth of records under the record group to include. -1 (everything) is applied, and answered, as 100.

statusFiltersIndexingStatusFilter[]

When set, only records matching these indexing statuses are reindexed.

Response

Reindexing triggered for all records in group

successtrue required
messagestring required
recordGroupIdstring required
depthinteger required
connectorIdstring required

Id of the connector instance the record group belongs to

connectorstring nullable required
eventPublishedboolean required

Changes

  • dbb5e203b445Revision changes
    • breaking

      removed the enum value AUTO_INDEX_OFF of the request property /

    • breaking

      removed the enum value COMPLETED of the request property /

    • breaking

      removed the enum value EMPTY of the request property /

    • breaking

      removed the enum value FAILED of the request property /

    • breaking

      removed the enum value FILE_TYPE_NOT_SUPPORTED of the request property /

    • breaking

      removed the enum value IN_PROGRESS of the request property /

    • breaking

      removed the enum value NOT_STARTED of the request property /

    • breaking

      removed the enum value QUEUED of the request property /

    • breaking

      removed the enum value SKIPPED of the request property /

    • warning

      removed the request property

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status

  • fc76aa045994Revision changes
    • info

      added the new SKIPPED enum value to the request property /