ExtensionsVectorData lodestarvectorstorecollection getservice - CyrilB1531/lodestar GitHub Wiki

HomeExtensionsVectorDataVector store

LodestarVectorStoreCollection.GetService

Answers for the collection's metadata.

public object GetService(Type serviceType, object serviceKey = null)

ParametersserviceType is the service being asked for. serviceKey names a keyed registration; nothing here is registered under one, so a keyed lookup answers null.

ExceptionsArgumentNullException when serviceType is null.

Returns — a VectorStoreCollectionMetadata whose VectorStoreSystemName is lodestar and whose CollectionName is the collection's Name, when serviceType is that type and serviceKey is null; null for anything else.

Example — the collection's name, reached through the abstraction.

using Lodestar.Extensions.VectorData;
using Microsoft.Extensions.VectorData;

using VectorStoreCollection<string, Note> notes = new LodestarVectorStoreCollection<string, Note>("notes");
var about = (VectorStoreCollectionMetadata)notes.GetService(typeof(VectorStoreCollectionMetadata));

string described = $"{about.VectorStoreSystemName}/{about.CollectionName}";  // => lodestar/notes

Remarks — the base class's member, and IKeywordHybridSearchable<TRecord>'s, are the same method here, so a consumer holding either interface gets the same answer. VectorStoreName is not set, since a collection constructed directly belongs to no store.

A new metadata object is returned on each call. A null serviceType throws, as the abstraction's contract for GetService says it must.

Applies to — net10.0, netstandard2.0.

See alsoLodestarVectorStore.GetService, LodestarVectorStoreCollection.

⚠️ **GitHub.com Fallback** ⚠️