Logo
Classes

QuestionsAnsweredExtractor

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:293

Extract questions from a list of nodes.

Extends

QuestionsAnsweredExtractor<Options>(nodes, options?): BaseNode<Metadata>[] | Promise<BaseNode<Metadata>[]>

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:293

Extract questions from a list of nodes.

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes

BaseNode<Metadata>[]

options?

Options

Returns

BaseNode<Metadata>[] | Promise<BaseNode<Metadata>[]>

Constructors

new QuestionsAnsweredExtractor()

new QuestionsAnsweredExtractor(options?): QuestionsAnsweredExtractor

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:327

Constructor for the QuestionsAnsweredExtractor class.

Parameters

options?

QuestionAnswerExtractArgs

Returns

QuestionsAnsweredExtractor

Overrides

BaseExtractor.constructor

Properties

llm

llm: LLM<object, object>

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:298

LLM instance.


questions

questions: number = 5

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:305

Number of questions to generate.

Default

5

promptTemplate

promptTemplate: QuestionExtractPrompt

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:311

The prompt template to use for the question extractor.


embeddingOnly

embeddingOnly: boolean = false

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:318

Wheter to use metadata for embeddings only

Default

false

isTextNodeOnly

isTextNodeOnly: boolean = true

Defined in: llamaindex/src/extractors/types.ts:13

Inherited from

BaseExtractor.isTextNodeOnly


showProgress

showProgress: boolean = true

Defined in: llamaindex/src/extractors/types.ts:14

Inherited from

BaseExtractor.showProgress


metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Defined in: llamaindex/src/extractors/types.ts:15

Inherited from

BaseExtractor.metadataMode


disableTemplateRewrite

disableTemplateRewrite: boolean = false

Defined in: llamaindex/src/extractors/types.ts:16

Inherited from

BaseExtractor.disableTemplateRewrite


inPlace

inPlace: boolean = true

Defined in: llamaindex/src/extractors/types.ts:17

Inherited from

BaseExtractor.inPlace


numWorkers

numWorkers: number = 4

Defined in: llamaindex/src/extractors/types.ts:18

Inherited from

BaseExtractor.numWorkers

Methods

extractQuestionsFromNode()

extractQuestionsFromNode(node): Promise<object | ExtractQuestion>

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:351

Extract answered questions from a node.

Parameters

node

BaseNode<Metadata>

Node to extract questions from.

Returns

Promise<object | ExtractQuestion>

Questions extracted from the node.


extract()

extract(nodes): Promise<object[] | ExtractQuestion[]>

Defined in: llamaindex/src/extractors/MetadataExtractors.ts:379

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

BaseExtractor.extract


processNodes()

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

Defined in: llamaindex/src/extractors/types.ts:41

Parameters

nodes

BaseNode<Metadata>[]

Nodes to extract metadata from.

excludedEmbedMetadataKeys

Metadata keys to exclude from the embedding.

undefined | string[]

excludedLlmMetadataKeys

Metadata keys to exclude from the LLM.

undefined | string[]

Returns

Promise<BaseNode<Metadata>[]>

Metadata extracted from the nodes.

Inherited from

BaseExtractor.processNodes