DefaultAugmentationPrompt

Model

DashAI.back.models.RAG.prompts.augmentation.DefaultAugmentationPrompt

Default prompt template for generating augmented retrieval queries.

Parameters

language : string, default=en: Language for the generated response.
template : string, default=: The prompt template with placeholders.

Methods

format(self, input: str, n_search_terms: int, **kwargs: Any) -> str

Defined on DefaultAugmentationPrompt

Render the augmentation prompt by replacing all placeholders.

calculate_metrics(self, split: DashAI.back.core.enums.metrics.SplitEnum = <SplitEnum.VALIDATION: 'validation'>, level: DashAI.back.core.enums.metrics.LevelEnum = <LevelEnum.LAST: 'last'>, log_index: int = None, x_data: 'DashAIDataset' = None, y_data: 'DashAIDataset' = None, fold_index: int = None, inner_fold_index: int = None)

Defined on BaseModel

Calculate and save metrics for a given data split and level.

Parameters

split : SplitEnum: The data split to evaluate (TRAIN, VALIDATION, or TEST). Defaults to SplitEnum.VALIDATION.
level : LevelEnum: The metric granularity level (LAST, TRIAL, STEP, or BATCH). Defaults to LevelEnum.LAST.
log_index : int, optional: Explicit step index for the metric entry. If None, the next step index is computed automatically. Defaults to None.
x_data : DashAIDataset, optional: Input features. If None, the dataset stored in the model for the given split is used. Defaults to None.
y_data : DashAIDataset, optional: Target labels. If None, the labels stored in the model for the given split are used. Defaults to None.

compute_metrics(self, split: DashAI.back.core.enums.metrics.SplitEnum = <SplitEnum.TEST: 'test'>, x_data: 'DashAIDataset' = None, y_data: 'DashAIDataset' = None) -> Dict[str, float]

Defined on BaseModel

Calculate and return metric scores for a given data split.

Parameters

split : SplitEnum: The data split to evaluate (TRAIN, VALIDATION, or TEST). Defaults to SplitEnum.VALIDATION.
x_data : DashAIDataset, optional: Input features. If None, the dataset stored in the model for the given split is used. Defaults to None.
y_data : DashAIDataset, optional: Target labels. If None, the labels stored in the model for the given split are used. Defaults to None.

Returns

Dict[str, float]: A dictionary mapping metric names to their computed scores.

get_credential(self, name: str)

Defined on ConfigObject

Resolve a registered credential component by name.

Parameters

name : str: Credential component class name (e.g. "HuggingFaceCredential").

Returns

BaseCredential: An instance of the requested credential component.

get_metadata(cls) -> Dict[str, Any]

Defined on Prompt

Retrieve class metadata.

get_optional_placeholders(self) -> List[str]

Defined on Prompt

Get the list of optional placeholders for the prompt template. Returns: List[str]: List of optional placeholders. Raises: AttributeError: If the subclass does not define 'optional_placeholders'.

get_required_placeholders(cls) -> List[str]

Defined on Prompt

Get the list of required placeholders for the prompt template. Returns: List[str]: List of required placeholders. Raises: AttributeError: If the subclass does not define 'required_placeholders'.

get_schema(cls) -> dict

Defined on ConfigObject

Generates the component related Json Schema.

Returns

dict: Dictionary representing the Json Schema of the component.

load(self, filename: str = '') -> None

Defined on Prompt

Load a prompt from a file.

predict_prepared(self, features: Any) -> Any

Defined on BaseModel

Predict from data that is already in this model's feature space.

Parameters

features : pandas.DataFrame or numpy.ndarray: Feature matrix as returned by prepare_dataset(..., is_fit=False). No further preparation is applied to it.

Returns

Any: The same kind of output as predict: predicted values for regressors, class probabilities for DashAI classifiers.

predict_proba_prepared(self, features: Any) -> Any

Defined on BaseModel

Return class probabilities for data already in the feature space.

Parameters

features : pandas.DataFrame or numpy.ndarray: Feature matrix as returned by prepare_dataset(..., is_fit=False).

Returns

numpy.ndarray: Array of shape (n_samples, n_classes) with class probabilities.

prepare_dataset(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'

Defined on BaseModel

Hook for model specific preprocessing of input features.

Parameters

dataset : DashAIDataset: The input dataset to preprocess.
is_fit : bool: Whether the call is part of a fitting phase. Defaults to False.

Returns

DashAIDataset: The preprocessed dataset ready to be fed into the model.

prepare_output(self, dataset: 'DashAIDataset', is_fit: bool = False) -> 'DashAIDataset'

Defined on BaseModel

Hook for model-specific preprocessing of output targets.

Parameters

dataset : DashAIDataset: The output dataset (target labels) to preprocess.
is_fit : bool: Whether the call is part of a fitting phase. Defaults to False.

Returns

DashAIDataset: The preprocessed output dataset.

save(self, filename: str = '') -> None

Defined on Prompt

Save the prompt to a file.

train(self, **kwargs: Any) -> None

Defined on Prompt

No-op training method for compatibility with the model interface.

validate_and_transform(self, raw_data: dict) -> dict

Defined on ConfigObject

It takes the data given by the user to initialize the model and returns it with all the objects that the model needs to work.

Parameters

raw_data : dict: A dictionary with the data provided by the user to initialize the model.

Returns

dict: A validated dictionary with the necessary objects.

validate_template(cls, template: str) -> bool

Defined on Prompt

Validate that the template contains all required placeholders. Args: template (str): The prompt template to be validated. Returns: bool: True if the template is valid, False otherwise.

Parameters​

Methods​

Parameters

Methods