Skip to main content
Version: latest

agrag.vectordb.weaviate.WeaviateSettings

Bases: BaseSettings

Weaviate connection and collection isolation settings.

Attributes:

  • mode (Literal['cloud', 'custom']) – Explicit cloud or custom deployment selection.
  • url (str) – HTTP endpoint, including scheme and optional port.
  • api_key (SecretStr | None) – Optional API key, hidden in representations and errors.
  • grpc_port (int) – Custom deployment gRPC port. Cloud uses TLS on port 443.
  • require_tls (bool) – Require encryption for non-loopback custom deployments.
  • collection_prefix (CollectionPrefix) – Required graph-specific prefix. Its first letter must be lowercase to prevent first-letter normalization collisions.

Environment variables use the WEAVIATE_ prefix. Both HTTP and gRPC must be reachable. Remote credentials require TLS on both transports.

api_key​

api_key: SecretStr | None = None

collection_prefix​

collection_prefix: CollectionPrefix

grpc_port​

grpc_port: int = Field(default=50051, ge=1, le=65535)

mode​

mode: Literal['cloud', 'custom'] = 'custom'

model_config​

model_config = SettingsConfigDict(env_prefix='WEAVIATE_', env_file='.env', extra='ignore', hide_input_in_errors=True)

require_tls​

require_tls: bool = False

url​

url: str = 'http://localhost:8080'