Compozy Symbol
ALPHA
DocsInstallGetting StartedFeaturesPricing
Quick StartDatabaseDeploymentConfigurationKnowledge BasesArchitectureTroubleshootingGuidesCoreCLI ReferenceSchema DefinitionAPI Reference

Embedder Schema

JSON Schema for embedding provider configuration

Embedder Definition

Schema Definition
EmbedderConfig describes an embedding provider used during knowledge ingestion.
api_key
string
config
object

EmbedderRuntimeConfig captures runtime tuning options for an embedder client.

id
string
model
string
provider
string

Example

embedders:
  - id: openai_default
    provider: openai
    model: text-embedding-3-small
    api_key: "{{ .env.OPENAI_API_KEY }}"
    config:
      batch_size: 64
      timeout: 30s
  • api_key and other credentials must use environment interpolation.
  • Optional config.batch_size overrides config.knowledge.embedder_batch_size.
  • Add provider-specific extras (e.g., base_url) using schema extension fields.

Resources

Knowledge Configuration Guide
See how embedder IDs are referenced inside knowledge bases.
Provider Schema
Additional provider-specific parameters.

Application Configuration

JSON Schema for application configuration

Vector Database Schema

JSON Schema for vector store configuration