Class: QuestionsAnsweredExtractor
Extract questions from a list of nodes.
Extends
Constructors
new QuestionsAnsweredExtractor()
new QuestionsAnsweredExtractor(
options?):QuestionsAnsweredExtractor
Constructor for the QuestionsAnsweredExtractor class.
Parameters
• options?: QuestionAnswerExtractArgs
Returns
Overrides
Source
packages/core/src/extractors/MetadataExtractors.ts:295
Properties
disableTemplateRewrite
disableTemplateRewrite:
boolean=false
Inherited from
BaseExtractor . disableTemplateRewrite
Source
packages/core/src/extractors/types.ts:13
embeddingOnly
embeddingOnly:
boolean=false
Wheter to use metadata for embeddings only
Default
false
Source
packages/core/src/extractors/MetadataExtractors.ts:286
inPlace
inPlace:
boolean=true
Inherited from
Source
packages/core/src/extractors/types.ts:14
isTextNodeOnly
isTextNodeOnly:
boolean=true
Inherited from
BaseExtractor . isTextNodeOnly
Source
packages/core/src/extractors/types.ts:10
llm
llm:
LLM<object,object>
LLM instance.
Source
packages/core/src/extractors/MetadataExtractors.ts:266
metadataMode
metadataMode:
MetadataMode=MetadataMode.ALL
Inherited from
Source
packages/core/src/extractors/types.ts:12
numWorkers
numWorkers:
number=4
Inherited from
Source
packages/core/src/extractors/types.ts:15
promptTemplate
promptTemplate:
string
The prompt template to use for the question extractor.
Source
packages/core/src/extractors/MetadataExtractors.ts:279
questions
questions:
number=5
Number of questions to generate.
Default
5
Source
packages/core/src/extractors/MetadataExtractors.ts:273
showProgress
showProgress:
boolean=true
Inherited from
Source
packages/core/src/extractors/types.ts:11
Methods
extract()
extract(
nodes):Promise<object[] |ExtractQuestion[]>
Extract answered questions from a list of nodes.
Parameters
• nodes: BaseNode <Metadata>[]
Nodes to extract questions from.
Returns
Promise<object[] | ExtractQuestion[]>
Questions extracted from the nodes.
Overrides
Source
packages/core/src/extractors/MetadataExtractors.ts:345
extractQuestionsFromNode()
extractQuestionsFromNode(
node):Promise<object|ExtractQuestion>
Extract answered questions from a node.
Parameters
Node to extract questions from.
Returns
Promise<object | ExtractQuestion>
Questions extracted from the node.
Source
packages/core/src/extractors/MetadataExtractors.ts:317
processNodes()
processNodes(
nodes,excludedEmbedMetadataKeys,excludedLlmMetadataKeys):Promise<BaseNode<Metadata>[]>
Parameters
• nodes: BaseNode <Metadata>[]
Nodes to extract metadata from.
• excludedEmbedMetadataKeys: undefined | string[]= undefined
Metadata keys to exclude from the embedding.
• excludedLlmMetadataKeys: undefined | string[]= undefined
Metadata keys to exclude from the LLM.
Returns
Promise <BaseNode <Metadata>[]>
Metadata extracted from the nodes.
Inherited from
Source
packages/core/src/extractors/types.ts:34
transform()
Parameters
• nodes: BaseNode <Metadata>[]
• options?: any
Returns
Promise <BaseNode <Metadata>[]>