Class WeaviateClientWrapper

Wrapper class for Weaviate client operations. Provides simplified methods for interacting with Weaviate vector database.

Index

Constructors

Methods

close collectionExists createCollection deleteCollection deleteObjects getClient getCollectionStats insertObjects search

Constructors

constructor

new WeaviateClientWrapper(params: WeaviateClientParams): WeaviateClientWrapper
Parameters
- params: WeaviateClientParams
Returns WeaviateClientWrapper
- Defined in src/client.ts:117

Methods

close

close(): Promise<void>
Close the client connection.

Returns Promise<void>
- Defined in src/client.ts:315

collectionExists

collectionExists(collectionName: string): Promise<boolean>
Check if a collection exists.
Parameters
- collectionName: string
Returns Promise<boolean>
- Defined in src/client.ts:166

createCollection

createCollection(config: CollectionConfig): Promise<void>
Create a collection if it doesn't exist.
Parameters
- config: CollectionConfig
Returns Promise<void>
- Defined in src/client.ts:180

deleteCollection

deleteCollection(collectionName: string): Promise<void>
Delete a collection.
Parameters
- collectionName: string
Returns Promise<void>
- Defined in src/client.ts:287

deleteObjects

deleteObjects(collectionName: string, ids: string[]): Promise<void>
Delete objects from a collection.
Parameters
- collectionName: string
- ids: string[]
Returns Promise<void>
- Defined in src/client.ts:275

getClient

getClient(): Promise<WeaviateClient>
Get the underlying Weaviate client.

Returns Promise<WeaviateClient>
- Defined in src/client.ts:158

getCollectionStats

getCollectionStats(
collectionName: string,
): Promise<{ name: string; objectCount: number }>
Get collection statistics.
Parameters
- collectionName: string
Returns Promise<{ name: string; objectCount: number }>
- Defined in src/client.ts:295

insertObjects

insertObjects(
    collectionName: string,
    objects: {
        id?: string;
        properties: Record<string, unknown>;
        vector: number[];
    }[],
): Promise<void>
Insert objects into a collection.
Parameters
- collectionName: string
- objects: { id?: string; properties: Record<string, unknown>; vector: number[] }[]
Returns Promise<void>
- Defined in src/client.ts:209

search

search(
    collectionName: string,
    vector: number[],
    limit?: number,
    options?: { distance?: number; filters?: FilterValue },
): Promise<SearchResult>
Search for similar vectors in a collection.
Parameters
- collectionName: string
  Name of the collection to search
- vector: number[]
  The query vector
- limit: number = 10
  Maximum number of results to return
- Optionaloptions: { distance?: number; filters?: FilterValue }
  Search options including filters
  - Optionaldistance?: number
    Maximum distance threshold for results
  - Optionalfilters?: FilterValue
    Weaviate filters - use weaviate.filter() to build complex filters, or pass a FilterValue directly. For simple property equality, the retriever will handle basic metadata filtering.
Returns Promise<SearchResult>
Search results with matching objects
- Defined in src/client.ts:246