The Components Service Configuration

09/02/2026

The Components Service is configured using environment variables.

Variable	Default	Details
`EMBEDDING_PROVIDER`	`aws`	Embedding provider: `aws` or `openai`
`EMBEDDING_MODEL_ID`	-	Embeddings model ID
`AWS_REGION`	`us-east-1`	AWS region (of the AWS provider)
`OPENAI_API_KEY`	-	OpenAI API key (of the OpenAI provider)
`OPENAI_BASE_URL`	empty	The base url for OpenAI API, if not set, then it uses `https://api.openai.com/v1/embeddings`

Variable	Default	Details
`VECTOR_STORE`	`elasticsearch`	Vector store type (see below)
`VECTOR_INDEX`	`index_name`	Default index name
`VECTOR_FIELD_NAME`	`vector_embedding`	Field containing embeddings

Variable	Default	Details
`ELASTIC_URL`		Required; the URL of the Elasticsearch instance
`ELASTIC_USERNAME`	`index_name`	Username if Basic Auth is used
`ELASTIC_PASSWORD`	`vector_embedding`	Password if Basic Auth is used
`ELASTIC_NUM_CANDIDATES`	`100`	value ofthe `num_candidates` parameter for Elasticsearch `knn` algorithm

Variable	Default	Details
`OPENSEARCH_ENDPOINT`	-	Required; the URL of the OpenSearch instance

If EMBEDDING_PROVIDER=aws and/or OpenSearch is hosted on AWS

AWS_ACCESS_KEY_ID

AWS_SECRET_ACCESS_KEY

AWS_REGION

These can be provided as env variables, or via the AWS security chain - using .aws local file, or by other means.

If VECTOR_STORE=opensearch_selfhosted, then only self-hosted OpenSearch instances without security are supported.

If VECTOR_STORE=elasticsearch, then only self-hosted Elasticsearch instances without security are supported.

ELASTIC_USERNAME - an optional username for Elasticsearch if Basic Authentication is used.

ELASTIC_PASSWORD - an optional password for Elasticsearch if Basic Authentication is used.

In this section: