VectorRepositoryService
Defined in: vector-repository-service.ts:36
A RepositoryService<T> over a VectorRepository<T> that ships the similar custom
method pre-wired to repository.findSimilar(). Register it with the method listed so
transports expose it (custom methods dispatch as POST /<path>/similar):
app.use("docs", new VectorRepositoryService(new DocRepository(app)), { methods: ["find", "get", "create", "update", "patch", "remove", "similar"],});Every result carries the adapter’s native match metric as _score — see the adapter
README for whether higher or lower means “more similar”.
Extends
Section titled “Extends”RepositoryService<T,D>
Type Parameters
Section titled “Type Parameters”T extends Record<string, unknown>
D = Partial<T>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new VectorRepositoryService<
T,D>(repository,options?):VectorRepositoryService<T,D>
Defined in: vector-repository-service.ts:40
Parameters
Section titled “Parameters”repository
Section titled “repository”VectorRepository<T, D>
options?
Section titled “options?”VectorRepositoryServiceOptions = {}
Returns
Section titled “Returns”VectorRepositoryService<T, D>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”options
Section titled “options”
protectedreadonlyoptions:VectorRepositoryServiceOptions={}
Defined in: vector-repository-service.ts:42
Inherited from
Section titled “Inherited from”repository
Section titled “repository”
protectedreadonlyrepository:VectorRepository<T,D>
Defined in: vector-repository-service.ts:41
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”assertFields()
Section titled “assertFields()”
protectedassertFields(where):void
Defined in: repository-service.ts:179
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”RepositoryService.assertFields
create()
Section titled “create()”Call Signature
Section titled “Call Signature”create(
data,_params?):Promise<T>
Defined in: repository-service.ts:83
Parameters
Section titled “Parameters”D
_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”create(
data,_params?):Promise<T[]>
Defined in: repository-service.ts:84
Parameters
Section titled “Parameters”D[]
_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T[]>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe():
RepositoryCapabilities|undefined
Defined in: repository-service.ts:105
Surface the underlying repository’s capabilities so ServiceHandle.describe() can include them.
Returns
Section titled “Returns”RepositoryCapabilities | undefined
Inherited from
Section titled “Inherited from”find()
Section titled “find()”find(
params?):Promise<Paginated<T>>
Defined in: repository-service.ts:50
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<Paginated<T>>
Inherited from
Section titled “Inherited from”get(
id,_params?):Promise<T>
Defined in: repository-service.ts:75
Parameters
Section titled “Parameters”_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”parseQuery()
Section titled “parseQuery()”
protectedparseQuery(query):ParsedQuery
Defined in: repository-service.ts:111
Parameters
Section titled “Parameters”Record<string, unknown>
Returns
Section titled “Returns”ParsedQuery
Inherited from
Section titled “Inherited from”patch()
Section titled “patch()”patch(
id,data,_params?):Promise<T>
Defined in: repository-service.ts:96
Parameters
Section titled “Parameters”D
_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”remove()
Section titled “remove()”remove(
id,_params?):Promise<T>
Defined in: repository-service.ts:100
Parameters
Section titled “Parameters”_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”similar()
Section titled “similar()”similar(
data,_params?):Promise<T&object[]>
Defined in: vector-repository-service.ts:47
Parameters
Section titled “Parameters”_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T & object[]>
update()
Section titled “update()”update(
id,data,_params?):Promise<T>
Defined in: repository-service.ts:92
Parameters
Section titled “Parameters”D
_params?
Section titled “_params?”Returns
Section titled “Returns”Promise<T>