メインコンテンツまでスキップ

Class: KeywordTableSimpleRetriever

Hierarchy

  • BaseKeywordTableRetriever

    KeywordTableSimpleRetriever

Constructors

constructor

new KeywordTableSimpleRetriever(«destructured»)

Parameters

NameType
«destructured»Object
› indexKeywordTableIndex
› keywordExtractTemplate?(__namedParameters: Object) => string
› maxKeywordsPerQuerynumber
› numChunksPerQuerynumber
› queryKeywordExtractTemplate?(__namedParameters: Object) => string

Inherited from

BaseKeywordTableRetriever.constructor

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:31

Properties

docstore

Protected docstore: BaseDocumentStore

Inherited from

BaseKeywordTableRetriever.docstore

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:23


index

Protected index: KeywordTableIndex

Inherited from

BaseKeywordTableRetriever.index

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:21


indexStruct

Protected indexStruct: KeywordTable

Inherited from

BaseKeywordTableRetriever.indexStruct

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:22


keywordExtractTemplate

Protected keywordExtractTemplate: (__namedParameters: Object) => string

Type declaration

▸ («destructured»): string

Parameters
NameType
«destructured»Object
Returns

string

Inherited from

BaseKeywordTableRetriever.keywordExtractTemplate

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:28


maxKeywordsPerQuery

Protected maxKeywordsPerQuery: number

Inherited from

BaseKeywordTableRetriever.maxKeywordsPerQuery

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:26


numChunksPerQuery

Protected numChunksPerQuery: number

Inherited from

BaseKeywordTableRetriever.numChunksPerQuery

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:27


queryKeywordExtractTemplate

Protected queryKeywordExtractTemplate: (__namedParameters: Object) => string

Type declaration

▸ («destructured»): string

Parameters
NameType
«destructured»Object
Returns

string

Inherited from

BaseKeywordTableRetriever.queryKeywordExtractTemplate

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:29


serviceContext

Protected serviceContext: ServiceContext

Inherited from

BaseKeywordTableRetriever.serviceContext

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:24

Methods

getKeywords

getKeywords(query): Promise<string[]>

Parameters

NameType
querystring

Returns

Promise<string[]>

Overrides

BaseKeywordTableRetriever.getKeywords

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:102


getServiceContext

getServiceContext(): ServiceContext

Returns

ServiceContext

Inherited from

BaseKeywordTableRetriever.getServiceContext

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:81


retrieve

retrieve(query): Promise<NodeWithScore<Metadata>[]>

Parameters

NameType
querystring

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseKeywordTableRetriever.retrieve

Defined in

packages/core/src/indices/keyword/KeywordTableIndexRetriever.ts:59