CustomAugmentationPrompt
User-defined augmentation prompt template for generating augmented retrieval prompts. It uses the language model to generate keywords or phrases that can be used to augment the input.
Parameters
- template : string, default=
- The prompt template with placeholders.
Methods
format(self, input: str, n_search_terms: int, **kwargs: Any) -> str
CustomAugmentationPromptInstantiate and format the prompt for augmentation. Args: input (str): The input to be formatted. n_search_terms (int): The number of search terms to generate. **kwargs: Additional keyword arguments for formatting. Returns: str: The formatted prompt.
get_credential(self, name: str)
ConfigObjectResolve 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]
BasePromptReturn the prompt-specific metadata declared by the subclass.
Returns
- Dict[str, Any]
- A copy of the class
metadataattribute, or an empty dict when the subclass does not declare one.
get_optional_placeholders(self) -> List[str]
BasePromptGet 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]
BasePromptGet 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
ConfigObjectGenerates the component related Json Schema.
Returns
- dict
- Dictionary representing the Json Schema of the component.
validate_and_transform(self, raw_data: dict) -> dict
ConfigObjectIt 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
BasePromptValidate 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.