Class: KeywordTableRAKERetriever
Extends
BaseKeywordTableRetriever
Constructors
new KeywordTableRAKERetriever()
new KeywordTableRAKERetriever(
__namedParameters
):KeywordTableRAKERetriever
Parameters
• __namedParameters
• __namedParameters.index: KeywordTableIndex
• __namedParameters.keywordExtractTemplate?
• __namedParameters.maxKeywordsPerQuery: number
= 10
• __namedParameters.numChunksPerQuery: number
= 10
• __namedParameters.queryKeywordExtractTemplate?
Returns
Inherited from
BaseKeywordTableRetriever.constructor
Source
packages/core/src/indices/keyword/index.ts:59
Properties
docstore
protected
docstore:BaseDocumentStore
Inherited from
BaseKeywordTableRetriever.docstore
Source
packages/core/src/indices/keyword/index.ts:51
index
protected
index:KeywordTableIndex
Inherited from
BaseKeywordTableRetriever.index
Source
packages/core/src/indices/keyword/index.ts:49
indexStruct
protected
indexStruct:KeywordTable
Inherited from
BaseKeywordTableRetriever.indexStruct
Source
packages/core/src/indices/keyword/index.ts:50
keywordExtractTemplate()
protected
keywordExtractTemplate: (__namedParameters
) =>string
Parameters
• __namedParameters
• __namedParameters.context: undefined
| string
= ""
• __namedParameters.maxKeywords: undefined
| number
= 10
Returns
string
Inherited from
BaseKeywordTableRetriever.keywordExtractTemplate
Source
packages/core/src/indices/keyword/index.ts:56
llm
protected
llm:LLM
<object
,object
>
Inherited from
BaseKeywordTableRetriever.llm
Source
packages/core/src/indices/keyword/index.ts:52
maxKeywordsPerQuery
protected
maxKeywordsPerQuery:number
Inherited from
BaseKeywordTableRetriever.maxKeywordsPerQuery
Source
packages/core/src/indices/keyword/index.ts:54
numChunksPerQuery
protected
numChunksPerQuery:number
Inherited from
BaseKeywordTableRetriever.numChunksPerQuery
Source
packages/core/src/indices/keyword/index.ts:55
queryKeywordExtractTemplate()
protected
queryKeywordExtractTemplate: (__namedParameters
) =>string
Parameters
• __namedParameters
• __namedParameters.maxKeywords: undefined
| number
= 10
• __namedParameters.question: undefined
| string
= ""
Returns
string
Inherited from
BaseKeywordTableRetriever.queryKeywordExtractTemplate
Source
packages/core/src/indices/keyword/index.ts:57
Methods
getKeywords()
getKeywords(
query
):Promise
<string
[]>
Parameters
• query: string
Returns
Promise
<string
[]>
Overrides
BaseKeywordTableRetriever.getKeywords
Source
packages/core/src/indices/keyword/index.ts:135
retrieve()
retrieve(
__namedParameters
):Promise
<NodeWithScore
<Metadata
>[]>
Parameters
• __namedParameters: RetrieveParams
Returns
Promise
<NodeWithScore
<Metadata
>[]>
Inherited from
BaseKeywordTableRetriever.retrieve