Struct swiftide_indexing::transformers::metadata_qa_code::MetadataQACode

pub struct MetadataQACode { /* private fields */ }

MetadataQACode is responsible for generating questions and answers based on code chunks. This struct integrates with the indexing pipeline to enhance the metadata of each code chunk by adding relevant questions and answers.

Implementations

impl MetadataQACode

pub fn builder() -> MetadataQACodeBuilder

pub fn from_client(client: impl SimplePrompt + 'static) -> MetadataQACodeBuilder

pub fn new(client: impl SimplePrompt + 'static) -> Self

Creates a new instance of MetadataQACode.

Arguments

• client - An implementation of the SimplePrompt trait used to generate questions and answers.

Returns

A new instance of MetadataQACode with a default prompt and a default number of questions.

pub fn with_concurrency(self, concurrency: usize) -> Self

Trait Implementations

impl Clone for MetadataQACode

fn clone(&self) -> MetadataQACode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetadataQACode

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Transformer for MetadataQACode

fn transform_node<'life0, 'async_trait>( &'life0 self, node: Node, ) -> Pin<Box<dyn Future<Output = Result<Node>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Asynchronously transforms an Node by generating questions and answers for its code chunk.

This method uses the SimplePrompt client to generate questions and answers based on the code chunk and adds this information to the node’s metadata.

Arguments

• node - The Node to be transformed.

Returns

A result containing the transformed Node or an error if the transformation fails.

Errors

This function will return an error if the SimplePrompt client fails to generate a response.

fn concurrency(&self) -> Option<usize>

Overrides the default concurrency of the pipeline