KeywordTableSimpleRetriever

Defined in: llamaindex/src/indices/keyword/index.ts:134

Extends

• BaseKeywordTableRetriever

Constructors

new KeywordTableSimpleRetriever()

new KeywordTableSimpleRetriever(__namedParameters): KeywordTableSimpleRetriever

Defined in: llamaindex/src/indices/keyword/index.ts:67

Parameters

__namedParameters

index

KeywordTableIndex

keywordExtractTemplate?

KeywordExtractPrompt

queryKeywordExtractTemplate?

QueryKeywordExtractPrompt

maxKeywordsPerQuery

number = 10

numChunksPerQuery

number = 10

Returns

KeywordTableSimpleRetriever

Inherited from

BaseKeywordTableRetriever.constructor

Properties

index

protected index: KeywordTableIndex

Defined in: llamaindex/src/indices/keyword/index.ts:57

Inherited from

BaseKeywordTableRetriever.index

---

indexStruct

protected indexStruct: KeywordTable

Defined in: llamaindex/src/indices/keyword/index.ts:58

Inherited from

BaseKeywordTableRetriever.indexStruct

---

docstore

protected docstore: BaseDocumentStore

Defined in: llamaindex/src/indices/keyword/index.ts:59

Inherited from

BaseKeywordTableRetriever.docstore

---

llm

protected llm: LLM<object, object>

Defined in: llamaindex/src/indices/keyword/index.ts:60

Inherited from

BaseKeywordTableRetriever.llm

---

maxKeywordsPerQuery

protected maxKeywordsPerQuery: number

Defined in: llamaindex/src/indices/keyword/index.ts:62

Inherited from

BaseKeywordTableRetriever.maxKeywordsPerQuery

---

numChunksPerQuery

protected numChunksPerQuery: number

Defined in: llamaindex/src/indices/keyword/index.ts:63

Inherited from

BaseKeywordTableRetriever.numChunksPerQuery

---

keywordExtractTemplate

protected keywordExtractTemplate: KeywordExtractPrompt

Defined in: llamaindex/src/indices/keyword/index.ts:64

Inherited from

BaseKeywordTableRetriever.keywordExtractTemplate

---

queryKeywordExtractTemplate

protected queryKeywordExtractTemplate: QueryKeywordExtractPrompt

Defined in: llamaindex/src/indices/keyword/index.ts:65

Inherited from

BaseKeywordTableRetriever.queryKeywordExtractTemplate

Methods

_retrieve()

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

Defined in: llamaindex/src/indices/keyword/index.ts:96

Parameters

query

QueryBundle

Returns

Promise<NodeWithScore<Metadata>[]>

Inherited from

BaseKeywordTableRetriever._retrieve

---

getKeywords()

getKeywords(query): Promise<string[]>

Defined in: llamaindex/src/indices/keyword/index.ts:135

Parameters

query

string

Returns

Promise<string[]>

Overrides

BaseKeywordTableRetriever.getKeywords