Admin¶

Runtime-agnostic administration services for managing knowledge base stores, documents, and canonical ground-truth storage.

Module Overview¶

The Admin module provides a single service class that wraps Vertex AI Agent Builder (Data Store) APIs and canonical object storage (S3 / GCS) into a unified, serverless-friendly interface.

Export	Kind	Description
`KnowledgeBaseAdminService`	Class	Core admin service for store & document management
`KnowledgeBaseAdminServiceConfig`	Interface	Service configuration
`KnowledgeBaseStoreInfo`	Interface	Store metadata
`KnowledgeBaseDocumentInfo`	Interface	Document metadata with ground-truth info
`CanonicalS3Config`	Interface	S3 / MinIO connection settings
`CanonicalGcsConfig`	Interface	GCS connection settings
`GroundTruthSourceType`	Type	`"s3" \\| "sharepoint" \\| string`

Quick Example¶

import {
  KnowledgeBaseAdminService,
  KnowledgeBaseAdminServiceConfig,
} from "@modernpath/agent-framework";

const config: KnowledgeBaseAdminServiceConfig = {
  defaultStore: "projects/my-proj/locations/global/collections/default_collection/dataStores/my-store",
  canonicalS3: {
    endpoint: "https://s3.eu-north-1.amazonaws.com",
    region: "eu-north-1",
    bucket: "my-kb-bucket",
    accessKeyId: process.env.S3_KEY!,
    secretAccessKey: process.env.S3_SECRET!,
  },
};

const admin = new KnowledgeBaseAdminService(config);

// List all stores
const { stores } = await admin.listStores();
console.log(stores);

// Upload a document
await admin.uploadDocument(
  stores[0].name,
  "guide.pdf",
  "application/pdf",
  pdfBytes,
);

Pages¶

Page	Description
KB Admin Service	Full API reference for `KnowledgeBaseAdminService`