Skip to content

base_model

arai_ai_agents.models.base_model

ModelInterface

Bases: ABC

Base class for all models.

Source code in arai_ai_agents/models/base_model.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class ModelInterface(ABC):
    """Base class for all models.        
    """
    @abstractmethod
    def generate_response(self, prompt: str) -> str:
        """ Generate a response to a given prompt.

        Args:
            prompt (str): The prompt to generate a response to.

        Returns:
            str: The generated response.

        Example:
            >>> base_model.generate_response("Hello, world!")
        """

        pass

generate_response(prompt) abstractmethod

Generate a response to a given prompt.

Parameters:

Name Type Description Default
prompt str

The prompt to generate a response to.

 required

Returns:

Name Type Description
str str

The generated response.
Example

base_model.generate_response("Hello, world!")

Source code in arai_ai_agents/models/base_model.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
@abstractmethod
def generate_response(self, prompt: str) -> str:
    """ Generate a response to a given prompt.

    Args:
        prompt (str): The prompt to generate a response to.

    Returns:
        str: The generated response.

    Example:
        >>> base_model.generate_response("Hello, world!")
    """

    pass