Class PostgresKnowledgeStore

Implements

KnowledgeStore

Index

Constructors

Methods

fromEnv close ensureSchema searchByEmbedding searchByText activateEmbeddingProfile getActiveEmbeddingProfile listKnowledgeSources markKnowledgeSourcesNeedingReindex upsertEmbeddingProfile upsertKnowledgeChunk upsertKnowledgeSource upsertKnowledgeSpace

Constructors

constructor

new PostgresKnowledgeStore(
options?: PostgresKnowledgeStoreOptions,
): PostgresKnowledgeStore
Parameters
- options: PostgresKnowledgeStoreOptions = {}
Returns PostgresKnowledgeStore
- Defined in src/retrieval.ts:1736

Methods

`Static`fromEnv

fromEnv(
options?: Omit<PostgresKnowledgeStoreOptions, "connectionString">,
): PostgresKnowledgeStore
Parameters
- options: Omit<PostgresKnowledgeStoreOptions, "connectionString"> = {}
Returns PostgresKnowledgeStore
- Defined in src/retrieval.ts:1751

close

close(): Promise<void>
Returns Promise<void>
- Defined in src/retrieval.ts:1761

ensureSchema

ensureSchema(): Promise<void>
Returns Promise<void>
- Defined in src/retrieval.ts:1771

searchByEmbedding

searchByEmbedding(
options: DenseKnowledgeSearchOptions,
): Promise<RetrievalResult[]>
Parameters
- options: DenseKnowledgeSearchOptions
Returns Promise<RetrievalResult[]>
Implementation of KnowledgeStore.searchByEmbedding
- Defined in src/retrieval.ts:1779

searchByText

searchByText(options: LexicalKnowledgeSearchOptions): Promise<RetrievalResult[]>
Parameters
- options: LexicalKnowledgeSearchOptions
Returns Promise<RetrievalResult[]>
Implementation of KnowledgeStore.searchByText
- Defined in src/retrieval.ts:1827

activateEmbeddingProfile

activateEmbeddingProfile(
options: PostgresActivateEmbeddingProfileOptions,
): Promise<void>
Parameters
- options: PostgresActivateEmbeddingProfileOptions
Returns Promise<void>
- Defined in src/retrieval.ts:1877

getActiveEmbeddingProfile

getActiveEmbeddingProfile(
filter: PostgresActiveEmbeddingProfileFilter,
): Promise<PostgresEmbeddingProfileRecord | null>
Parameters
- filter: PostgresActiveEmbeddingProfileFilter
Returns Promise<PostgresEmbeddingProfileRecord | null>
- Defined in src/retrieval.ts:1916

listKnowledgeSources

listKnowledgeSources(
options: PostgresKnowledgeSourceListOptions,
): Promise<PostgresKnowledgeSourceRecord[]>
Parameters
- options: PostgresKnowledgeSourceListOptions
Returns Promise<PostgresKnowledgeSourceRecord[]>
- Defined in src/retrieval.ts:1952

markKnowledgeSourcesNeedingReindex

markKnowledgeSourcesNeedingReindex(
options: PostgresMarkKnowledgeSourcesNeedingReindexOptions,
): Promise<number>
Parameters
- options: PostgresMarkKnowledgeSourcesNeedingReindexOptions
Returns Promise<number>
- Defined in src/retrieval.ts:2005

upsertEmbeddingProfile

upsertEmbeddingProfile(
record: PostgresEmbeddingProfileRecord,
): Promise<PostgresEmbeddingProfileRecord>
Parameters
- record: PostgresEmbeddingProfileRecord
Returns Promise<PostgresEmbeddingProfileRecord>
- Defined in src/retrieval.ts:2040

upsertKnowledgeChunk

upsertKnowledgeChunk(
record: PostgresKnowledgeChunkRecord,
): Promise<PostgresKnowledgeChunkRecord>
Parameters
- record: PostgresKnowledgeChunkRecord
Returns Promise<PostgresKnowledgeChunkRecord>
- Defined in src/retrieval.ts:2100

upsertKnowledgeSource

upsertKnowledgeSource(
record: PostgresKnowledgeSourceRecord,
): Promise<PostgresKnowledgeSourceRecord>
Parameters
- record: PostgresKnowledgeSourceRecord
Returns Promise<PostgresKnowledgeSourceRecord>
- Defined in src/retrieval.ts:2196

upsertKnowledgeSpace

upsertKnowledgeSpace(
record: PostgresKnowledgeSpaceRecord,
): Promise<PostgresKnowledgeSpaceRecord>
Parameters
- record: PostgresKnowledgeSpaceRecord
Returns Promise<PostgresKnowledgeSpaceRecord>
- Defined in src/retrieval.ts:2275