Knowledge Commands

Overview

compozy knowledge [command]

Subcommands

• list – List knowledge bases with pagination.
• get – Fetch a single knowledge base in YAML or JSON format.
• apply – Create or update knowledge resources; respects ETag concurrency.
• delete – Remove a knowledge base and associated vectors.
• ingest – Trigger ingestion for the specified knowledge base.
• query – Execute dense retrieval against a knowledge base.

compozy knowledge list

compozy knowledge list --project ./examples/knowledge/quickstart-markdown-glob

compozy knowledge get

compozy knowledge get quickstart_docs --format yaml

• Supports strong ETag concurrency using the etag field in responses.
• Combine with --output to write definitions to disk.

compozy knowledge apply

compozy knowledge apply --file compozy.yaml

• Applies embedders, vector DBs, and knowledge bases in a single pass.
• Use --dry-run to preview changes without persisting them.
• Matches the API semantics of PUT /knowledge-bases/{kb_id}.

compozy knowledge delete

compozy knowledge delete quickstart_docs --force

• Removal cascades to vector rows only; external blob stores remain untouched.
• Requires confirmation unless --force is provided.

compozy knowledge ingest

compozy knowledge ingest --id quickstart_docs --project examples/knowledge/quickstart-markdown-glob

• Idempotent: unchanged chunks are skipped automatically.
• Use --batch-size to override config.knowledge.embedder_batch_size for a single run.
• With --verbose, structured logs show chunk counts and failures sourced from logger.FromContext(ctx).

compozy knowledge query

compozy knowledge query --id quickstart_docs \
  --text "What is the support SLA?" \
  --top_k 3 \
  --min_score 0.25 \
  --output json

• Returns scored matches, metadata, and ETags for auditing.
• Combine with jq to inspect chunk IDs and source paths.

End-to-End Walkthroughs

Best Practices

For additional automation patterns, see the Knowledge Ingestion guide.