Class: KeywordTableSimpleRetriever

Extends

• BaseKeywordTableRetriever

Constructors

new KeywordTableSimpleRetriever()

new KeywordTableSimpleRetriever(__namedParameters): KeywordTableSimpleRetriever

Parameters

• __namedParameters

• __namedParameters.index: KeywordTableIndex

• __namedParameters.keywordExtractTemplate?

• __namedParameters.maxKeywordsPerQuery: number= 10

• __namedParameters.numChunksPerQuery: number= 10

• __namedParameters.queryKeywordExtractTemplate?

Returns

KeywordTableSimpleRetriever

Inherited from

BaseKeywordTableRetriever.constructor

Source

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

Properties

docstore

protected docstore: BaseDocumentStore

Inherited from

BaseKeywordTableRetriever.docstore

Source

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

---

index

protected index: KeywordTableIndex

Inherited from

BaseKeywordTableRetriever.index

Source

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

---

indexStruct

protected indexStruct: KeywordTable

Inherited from

BaseKeywordTableRetriever.indexStruct

Source

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

---

keywordExtractTemplate()

protected keywordExtractTemplate: (__namedParameters) => string

Parameters

• __namedParameters

• __namedParameters.context: undefined | string= ""

• __namedParameters.maxKeywords: undefined | number= 10

Returns

string

Inherited from

BaseKeywordTableRetriever.keywordExtractTemplate

Source

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

---

llm

protected llm: LLM<object, object>

Inherited from

BaseKeywordTableRetriever.llm

Source

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

---

maxKeywordsPerQuery

protected maxKeywordsPerQuery: number

Inherited from

BaseKeywordTableRetriever.maxKeywordsPerQuery

Source

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

---

numChunksPerQuery

protected numChunksPerQuery: number

Inherited from

BaseKeywordTableRetriever.numChunksPerQuery

Source

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

---

queryKeywordExtractTemplate()

protected queryKeywordExtractTemplate: (__namedParameters) => string

Parameters

• __namedParameters

• __namedParameters.maxKeywords: undefined | number= 10

• __namedParameters.question: undefined | string= ""

Returns

string

Inherited from

BaseKeywordTableRetriever.queryKeywordExtractTemplate

Source

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

Methods

getKeywords()

getKeywords(query): Promise<string[]>

Parameters

• query: string

Returns

Promise<string[]>

Overrides

BaseKeywordTableRetriever.getKeywords

Source

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

---

retrieve()

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

Parameters

• __namedParameters: RetrieveParams

Returns

Promise <NodeWithScore <Metadata>[]>

Inherited from

BaseKeywordTableRetriever.retrieve

Source

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