WeaviateKernelBuilderExtensions.AddWeaviateVectorStoreRecordCollection<TRecord> Method

Definition

Namespace:: Microsoft.SemanticKernel

Assembly:: Microsoft.SemanticKernel.Connectors.Weaviate.dll

Package:: Microsoft.SemanticKernel.Connectors.Weaviate v1.45.0-preview

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Register a Weaviate Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2 and Microsoft.Extensions.VectorData.IVectorizedSearch`1 with the specified service ID.

public static Microsoft.SemanticKernel.IKernelBuilder AddWeaviateVectorStoreRecordCollection<TRecord>(this Microsoft.SemanticKernel.IKernelBuilder builder, string collectionName, System.Net.Http.HttpClient? httpClient = default, Microsoft.SemanticKernel.Connectors.Weaviate.WeaviateVectorStoreRecordCollectionOptions<TRecord>? options = default, string? serviceId = default);

static member AddWeaviateVectorStoreRecordCollection : Microsoft.SemanticKernel.IKernelBuilder * string * System.Net.Http.HttpClient * Microsoft.SemanticKernel.Connectors.Weaviate.WeaviateVectorStoreRecordCollectionOptions<'Record> * string -> Microsoft.SemanticKernel.IKernelBuilder

<Extension()>
Public Function AddWeaviateVectorStoreRecordCollection(Of TRecord) (builder As IKernelBuilder, collectionName As String, Optional httpClient As HttpClient = Nothing, Optional options As WeaviateVectorStoreRecordCollectionOptions(Of TRecord) = Nothing, Optional serviceId As String = Nothing) As IKernelBuilder

Type Parameters

TRecord

The type of the record.

Parameters

builder: IKernelBuilder

The builder to register the Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2 on.

collectionName: String

The name of the collection.

httpClient: HttpClient

HttpClient that is used to interact with Weaviate API. BaseAddress should point to remote or local cluster and API key can be configured via DefaultRequestHeaders. It's also possible to provide these parameters via WeaviateVectorStoreOptions.

options: WeaviateVectorStoreRecordCollectionOptions<TRecord>

Optional options to further configure the Microsoft.Extensions.VectorData.IVectorStoreRecordCollection`2.

serviceId: String

An optional service id to use as the service key.

Returns

IKernelBuilder

The kernel builder.

Applies to