Skip to main content

Class: QuestionsAnsweredExtractor()

Extract questions from a list of nodes.

Extends

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

Extract questions from a list of nodes.

Type Parameters

Options extends Record<string, unknown>

Parameters

nodes: BaseNode<Metadata>[]

options?: Options

Returns

Promise<BaseNode<Metadata>[]>

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:261

Constructors

new QuestionsAnsweredExtractor()

new QuestionsAnsweredExtractor(options?): QuestionsAnsweredExtractor

Constructor for the QuestionsAnsweredExtractor class.

Parameters

options?: QuestionAnswerExtractArgs

Returns

QuestionsAnsweredExtractor

Overrides

BaseExtractor.constructor

Defined in

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

Properties

disableTemplateRewrite

disableTemplateRewrite: boolean = false

Inherited from

BaseExtractor.disableTemplateRewrite

Defined in

packages/llamaindex/src/extractors/types.ts:16


embeddingOnly

embeddingOnly: boolean = false

Wheter to use metadata for embeddings only

Default

false

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:286


id

id: string

Inherited from

BaseExtractor.id

Defined in

packages/core/schema/dist/schema/index.d.ts:171


inPlace

inPlace: boolean = true

Inherited from

BaseExtractor.inPlace

Defined in

packages/llamaindex/src/extractors/types.ts:17


isTextNodeOnly

isTextNodeOnly: boolean = true

Inherited from

BaseExtractor.isTextNodeOnly

Defined in

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


llm

llm: LLM<object, object>

LLM instance.

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:266


metadataMode

metadataMode: MetadataMode = MetadataMode.ALL

Inherited from

BaseExtractor.metadataMode

Defined in

packages/llamaindex/src/extractors/types.ts:15


numWorkers

numWorkers: number = 4

Inherited from

BaseExtractor.numWorkers

Defined in

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


promptTemplate

promptTemplate: string

The prompt template to use for the question extractor.

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:279


questions

questions: number = 5

Number of questions to generate.

Default

5

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:273


showProgress

showProgress: boolean = true

Inherited from

BaseExtractor.showProgress

Defined in

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

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

BaseExtractor.extract

Defined in

packages/llamaindex/src/extractors/MetadataExtractors.ts:345


extractQuestionsFromNode()

extractQuestionsFromNode(node): Promise<object | ExtractQuestion>

Extract answered questions from a node.

Parameters

node: BaseNode<Metadata>

Node to extract questions from.

Returns

Promise<object | ExtractQuestion>

Questions extracted from the node.

Defined in

packages/llamaindex/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

BaseExtractor.processNodes

Defined in

packages/llamaindex/src/extractors/types.ts:39