Class: QuestionsAnsweredExtractor

Extract questions from a list of nodes.

Hierarchy

• BaseExtractor

  ↳ QuestionsAnsweredExtractor

Constructors

constructor

• new QuestionsAnsweredExtractor(llm, questions?, promptTemplate?, embeddingOnly?): QuestionsAnsweredExtractor

Constructor for the QuestionsAnsweredExtractor class.

Parameters

Name	Type	Default value	Description
llm	LLM	undefined	LLM instance.
questions	number	5	Number of questions to generate.
promptTemplate?	string	undefined	The prompt template to use for the question extractor.
embeddingOnly	boolean	false	Wheter to use metadata for embeddings only.

Returns

QuestionsAnsweredExtractor

Overrides

BaseExtractor.constructor

Defined in

packages/core/src/extractors/MetadataExtractors.ts:241

Properties

disableTemplateRewrite

• disableTemplateRewrite: boolean = false

Inherited from

BaseExtractor.disableTemplateRewrite

Defined in

packages/core/src/extractors/types.ts:12

---

embeddingOnly

• embeddingOnly: boolean = false

Wheter to use metadata for embeddings only

Default

false

Defined in

packages/core/src/extractors/MetadataExtractors.ts:232

---

inPlace

• inPlace: boolean = true

Inherited from

BaseExtractor.inPlace

Defined in

packages/core/src/extractors/types.ts:13

---

isTextNodeOnly

• isTextNodeOnly: boolean = true

Inherited from

BaseExtractor.isTextNodeOnly

Defined in

packages/core/src/extractors/types.ts:9

---

llm

• llm: LLM

LLM instance.

Defined in

packages/core/src/extractors/MetadataExtractors.ts:212

---

metadataMode

• metadataMode: MetadataMode = MetadataMode.ALL

Inherited from

BaseExtractor.metadataMode

Defined in

packages/core/src/extractors/types.ts:11

---

numWorkers

• numWorkers: number = 4

Inherited from

BaseExtractor.numWorkers

Defined in

packages/core/src/extractors/types.ts:14

---

promptTemplate

• promptTemplate: string

The prompt template to use for the question extractor.

Defined in

packages/core/src/extractors/MetadataExtractors.ts:225

---

questions

• questions: number = 5

Number of questions to generate.

Default

5

Defined in

packages/core/src/extractors/MetadataExtractors.ts:219

---

showProgress

• showProgress: boolean = true

Inherited from

BaseExtractor.showProgress

Defined in

packages/core/src/extractors/types.ts:10

Methods

extract

▸ extract(nodes): Promise<{}[] | ExtractQuestion[]>

Extract answered questions from a list of nodes.

Parameters

Name	Type	Description
nodes	BaseNode<Metadata>[]	Nodes to extract questions from.

Returns

Promise<{}[] | ExtractQuestion[]>

Questions extracted from the nodes.

Overrides

BaseExtractor.extract

Defined in

packages/core/src/extractors/MetadataExtractors.ts:295

---

extractQuestionsFromNode

▸ extractQuestionsFromNode(node): Promise<{} | ExtractQuestion>

Extract answered questions from a node.

Parameters

Name	Type	Description
node	BaseNode<Metadata>	Node to extract questions from.

Returns

Promise<{} | ExtractQuestion>

Questions extracted from the node.

Defined in

packages/core/src/extractors/MetadataExtractors.ts:267

---

processNodes

▸ processNodes(nodes, excludedEmbedMetadataKeys?, excludedLlmMetadataKeys?): Promise<BaseNode<Metadata>[]>

Parameters

Name	Type	Default value	Description
nodes	BaseNode<Metadata>[]	undefined	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

BaseExtractor.processNodes

Defined in

packages/core/src/extractors/types.ts:33

---

transform

▸ transform(nodes, options?): Promise<BaseNode<Metadata>[]>

Parameters

Name	Type
nodes	BaseNode<Metadata>[]
options?	any

Returns

Promise<BaseNode<Metadata>[]>

Inherited from

BaseExtractor.transform

Defined in

packages/core/src/extractors/types.ts:18