KeywordTableSimpleRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:134
Extends
Section titled “Extends”BaseKeywordTableRetriever
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new KeywordTableSimpleRetriever(
__namedParameters):KeywordTableSimpleRetriever
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:67
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”keywordExtractTemplate?
Section titled “keywordExtractTemplate?”KeywordExtractPrompt
queryKeywordExtractTemplate?
Section titled “queryKeywordExtractTemplate?”QueryKeywordExtractPrompt
maxKeywordsPerQuery
Section titled “maxKeywordsPerQuery”number = 10
numChunksPerQuery
Section titled “numChunksPerQuery”number = 10
Returns
Section titled “Returns”KeywordTableSimpleRetriever
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.constructor
Properties
Section titled “Properties”
protectedindex:KeywordTableIndex
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:57
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.index
indexStruct
Section titled “indexStruct”
protectedindexStruct:KeywordTable
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:58
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.indexStruct
docstore
Section titled “docstore”
protecteddocstore:BaseDocumentStore
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:59
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.docstore
protectedllm:LLM
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:60
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.llm
maxKeywordsPerQuery
Section titled “maxKeywordsPerQuery”
protectedmaxKeywordsPerQuery:number
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:62
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.maxKeywordsPerQuery
numChunksPerQuery
Section titled “numChunksPerQuery”
protectednumChunksPerQuery:number
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:63
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.numChunksPerQuery
keywordExtractTemplate
Section titled “keywordExtractTemplate”
protectedkeywordExtractTemplate:KeywordExtractPrompt
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:64
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.keywordExtractTemplate
queryKeywordExtractTemplate
Section titled “queryKeywordExtractTemplate”
protectedqueryKeywordExtractTemplate:QueryKeywordExtractPrompt
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:65
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever.queryKeywordExtractTemplate
Methods
Section titled “Methods”_retrieve()
Section titled “_retrieve()”_retrieve(
query):Promise<NodeWithScore<Metadata>[]>
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:96
Parameters
Section titled “Parameters”QueryBundle
Returns
Section titled “Returns”Promise<NodeWithScore<Metadata>[]>
Inherited from
Section titled “Inherited from”BaseKeywordTableRetriever._retrieve
getKeywords()
Section titled “getKeywords()”getKeywords(
query):Promise<string[]>
Defined in: .build/typescript/packages/llamaindex/src/indices/keyword/index.ts:135
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<string[]>
Overrides
Section titled “Overrides”BaseKeywordTableRetriever.getKeywords