Skip to main content
Weaviate is an open-source vector search engine. It allows efficient storage and retrieval of high-dimensional vector embeddings, enabling powerful search and retrieval capabilities.

Installation

Usage

The TypeScript SDK picks the connection mode from the config you pass:
  • clusterUrl pointing at localhost connects to a local instance.
  • clusterUrl plus apiKey connects to a Weaviate Cloud cluster (for example https://my-cluster.weaviate.cloud).
  • Any other clusterUrl without an apiKey connects to a custom deployment, using the host and port from the URL.
You can also pass a pre-configured client (a WeaviateClient instance) to reuse an existing connection.

Config

Here are the parameters available for configuring Weaviate: