Skip to main content

Class: KeywordTableLLMRetriever

Extends

  • BaseKeywordTableRetriever

Constructors

new KeywordTableLLMRetriever()

new KeywordTableLLMRetriever(__namedParameters): KeywordTableLLMRetriever

Parameters

__namedParameters

__namedParameters.index: KeywordTableIndex

__namedParameters.keywordExtractTemplate?: KeywordExtractPrompt

__namedParameters.maxKeywordsPerQuery: number = 10

__namedParameters.numChunksPerQuery: number = 10

__namedParameters.queryKeywordExtractTemplate?: QueryKeywordExtractPrompt

Returns

KeywordTableLLMRetriever

Inherited from

BaseKeywordTableRetriever.constructor

Defined in

packages/llamaindex/src/indices/keyword/index.ts:62

Properties

docstore

protected docstore: BaseDocumentStore

Inherited from

BaseKeywordTableRetriever.docstore

Defined in

packages/llamaindex/src/indices/keyword/index.ts:54


index

protected index: KeywordTableIndex

Inherited from

BaseKeywordTableRetriever.index

Defined in

packages/llamaindex/src/indices/keyword/index.ts:52


indexStruct

protected indexStruct: KeywordTable

Inherited from

BaseKeywordTableRetriever.indexStruct

Defined in

packages/llamaindex/src/indices/keyword/index.ts:53


keywordExtractTemplate

protected keywordExtractTemplate: KeywordExtractPrompt

Inherited from

BaseKeywordTableRetriever.keywordExtractTemplate

Defined in

packages/llamaindex/src/indices/keyword/index.ts:59


llm

protected llm: LLM<object, object>

Inherited from

BaseKeywordTableRetriever.llm

Defined in

packages/llamaindex/src/indices/keyword/index.ts:55


maxKeywordsPerQuery

protected maxKeywordsPerQuery: number

Inherited from

BaseKeywordTableRetriever.maxKeywordsPerQuery

Defined in

packages/llamaindex/src/indices/keyword/index.ts:57


numChunksPerQuery

protected numChunksPerQuery: number

Inherited from

BaseKeywordTableRetriever.numChunksPerQuery

Defined in

packages/llamaindex/src/indices/keyword/index.ts:58


queryKeywordExtractTemplate

protected queryKeywordExtractTemplate: QueryKeywordExtractPrompt

Inherited from

BaseKeywordTableRetriever.queryKeywordExtractTemplate

Defined in

packages/llamaindex/src/indices/keyword/index.ts:60

Methods

getKeywords()

getKeywords(query): Promise<string[]>

Parameters

query: string

Returns

Promise<string[]>

Overrides

BaseKeywordTableRetriever.getKeywords

Defined in

packages/llamaindex/src/indices/keyword/index.ts:115


retrieve()

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

Parameters

__namedParameters: RetrieveParams

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseKeywordTableRetriever.retrieve

Defined in

packages/llamaindex/src/indices/keyword/index.ts:90