Struct MetadataTitle

pub struct MetadataTitle { /* private fields */ }

This module defines the MetadataTitle struct and its associated methods, which are used for generating metadata in the form of a title for a given text. It interacts with a client (e.g., OpenAI) to generate these questions and answers based on the text chunk in an Node. MetadataTitle is responsible for generating a title for a given text chunk. It uses a templated prompt to interact with a client that implements the SimplePrompt trait.

Implementations

impl MetadataTitle

pub fn builder() -> MetadataTitleBuilder

Creates a new builder for the transformer

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

Build a new transformer from a client

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

Create a new transformer from a client

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

Set the concurrency level for the transformer

Trait Implementations

impl Clone for MetadataTitle

fn clone(&self) -> MetadataTitle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataTitle

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

Formats the value using the given formatter.

impl Default for MetadataTitle

fn default() -> Self

Returns the “default value” for a type.

impl Transformer for MetadataTitle

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,

Transforms an Node by generating questions and answers based on the text chunk within the node.

Arguments

• node - The Node containing the text chunk to process.

Returns

A Result containing the transformed Node with added metadata, or an error if the transformation fails.

Errors

This function will return an error if the client fails to generate questions and answers from the provided prompt.

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

Overrides the default concurrency of the pipeline

fn name(&self) -> &'static str

impl WithIndexingDefaults for MetadataTitle

fn with_indexing_defaults(&mut self, defaults: IndexingDefaults)