Skip to content

inputs

Contain classes used to define the inputs of a model.

Audio dataclass

Contains an audio that can be passed to a multimodal model.

Provide one or several instances of this class along with a text prompt in a list as the model_input argument to a model that supports audio processing.

Parameters:

Name Type Description Default
audio Any

The audio to use in the text generation.

 required
Source code in outlines/inputs.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
@dataclass
class Audio:
    """Contains an audio that can be passed to a multimodal model.

    Provide one or several instances of this class along with a text prompt
    in a list as the `model_input` argument to a model that supports audio
    processing.

    Parameters
    ----------
    audio
        The audio to use in the text generation.

    """
    audio: Any

Chat dataclass

Contains the input for a chat model.

Provide an instance of this class as the model_input argument to a model that supports chat.

Each message contained in the messages list must be a dict with 'role' and 'content' keys. The role can be 'user', 'assistant', or 'system'. The content can be a string or a list containing a str and assets (images, videos, audios, etc.) in the case of multimodal models.

Examples:

# Initialize the chat with a system message.
chat_prompt = Chat([
    {"role": "system", "content": "You are a helpful assistant."},
])

# Add a user message with an image and call the model (not shown here).
chat_prompt.add_user_message(["Describe the image below", Image(image)])

# Add as an assistant message the response from the model.
chat_prompt.add_assistant_message("The is a black cat sitting on a couch.")

Parameters:

Name Type Description Default
messages List[Dict[str, Any]]

The list of messages that will be provided to the model.

 None
Source code in outlines/inputs.py 
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
@dataclass
class Chat:
    """Contains the input for a chat model.

    Provide an instance of this class as the `model_input` argument to a model
    that supports chat.

    Each message contained in the messages list must be a dict with 'role' and
    'content' keys. The role can be 'user', 'assistant', or 'system'. The content
    can be a string or a list containing a str and assets (images, videos,
    audios, etc.) in the case of multimodal models.

    Examples
    --------
    ```python
    # Initialize the chat with a system message.
    chat_prompt = Chat([
        {"role": "system", "content": "You are a helpful assistant."},
    ])

    # Add a user message with an image and call the model (not shown here).
    chat_prompt.add_user_message(["Describe the image below", Image(image)])

    # Add as an assistant message the response from the model.
    chat_prompt.add_assistant_message("The is a black cat sitting on a couch.")
    ```

    Parameters
    ----------
    messages
        The list of messages that will be provided to the model.

    """
    messages: List[Dict[str, Any]] = None # type: ignore

    def __post_init__(self):
        if self.messages is None:
            self.messages = []

    def append(self, message: Dict[str, Any]):
        """Add a message to the chat.

        Parameters
        ----------
        message
            The message to add to the chat.

        """
        self.messages.append(message)

    def extend(self, messages: List[Dict[str, Any]]):
        """Add a list of messages to the chat.

        Parameters
        ----------
        messages
            The list of messages to add to the chat.

        """
        self.messages.extend(messages)

    def pop(self) -> Dict[str, Any]:
        """Remove the last message from the chat.

        Returns
        -------
        message
            The removed message.

        """
        return self.messages.pop()

    def add_system_message(self, content: str | List[Any]):
        """Add a system message to the chat.

        Parameters
        ----------
        content
            The content of the system message.

        """
        self.messages.append({"role": "system", "content": content})

    def add_user_message(self, content: str | List[Any]):
        """Add a user message to the chat.

        Parameters
        ----------
        content
            The content of the user message.

        """
        self.messages.append({"role": "user", "content": content})

    def add_assistant_message(self, content: str | List[Any]):
        """Add an assistant message to the chat.

        Parameters
        ----------
        content
            The content of the assistant message.

        """
        self.messages.append({"role": "assistant", "content": content})

    def __str__(self):
        return "\n".join(str(message) for message in self.messages)

    def __repr__(self):
        return f"Chat(messages={self.messages})"

add_assistant_message(content)

Add an assistant message to the chat.

Parameters:

Name Type Description Default
content str | List[Any]

The content of the assistant message.

 required
Source code in outlines/inputs.py 
168
169
170
171
172
173
174
175
176
177
def add_assistant_message(self, content: str | List[Any]):
    """Add an assistant message to the chat.

    Parameters
    ----------
    content
        The content of the assistant message.

    """
    self.messages.append({"role": "assistant", "content": content})

add_system_message(content)

Add a system message to the chat.

Parameters:

Name Type Description Default
content str | List[Any]

The content of the system message.

 required
Source code in outlines/inputs.py 
146
147
148
149
150
151
152
153
154
155
def add_system_message(self, content: str | List[Any]):
    """Add a system message to the chat.

    Parameters
    ----------
    content
        The content of the system message.

    """
    self.messages.append({"role": "system", "content": content})

add_user_message(content)

Add a user message to the chat.

Parameters:

Name Type Description Default
content str | List[Any]

The content of the user message.

 required
Source code in outlines/inputs.py 
157
158
159
160
161
162
163
164
165
166
def add_user_message(self, content: str | List[Any]):
    """Add a user message to the chat.

    Parameters
    ----------
    content
        The content of the user message.

    """
    self.messages.append({"role": "user", "content": content})

append(message)

Add a message to the chat.

Parameters:

Name Type Description Default
message Dict[str, Any]

The message to add to the chat.

 required
Source code in outlines/inputs.py 
113
114
115
116
117
118
119
120
121
122
def append(self, message: Dict[str, Any]):
    """Add a message to the chat.

    Parameters
    ----------
    message
        The message to add to the chat.

    """
    self.messages.append(message)

extend(messages)

Add a list of messages to the chat.

Parameters:

Name Type Description Default
messages List[Dict[str, Any]]

The list of messages to add to the chat.

 required
Source code in outlines/inputs.py 
124
125
126
127
128
129
130
131
132
133
def extend(self, messages: List[Dict[str, Any]]):
    """Add a list of messages to the chat.

    Parameters
    ----------
    messages
        The list of messages to add to the chat.

    """
    self.messages.extend(messages)

pop()

Remove the last message from the chat.

Returns:

Type Description
message

The removed message.
Source code in outlines/inputs.py 
135
136
137
138
139
140
141
142
143
144
def pop(self) -> Dict[str, Any]:
    """Remove the last message from the chat.

    Returns
    -------
    message
        The removed message.

    """
    return self.messages.pop()

Image dataclass

Contains an image that can be passed to a multimodal model.

Provide one or several instances of this class along with a text prompt in a list as the model_input argument to a model that supports vision.

Parameters:

Name Type Description Default
image Image

The image to use in the text generation.

 required
Source code in outlines/inputs.py 
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
@dataclass
class Image:
    """Contains an image that can be passed to a multimodal model.

    Provide one or several instances of this class along with a text prompt
    in a list as the `model_input` argument to a model that supports vision.

    Parameters
    ----------
    image
        The image to use in the text generation.

    """
    image: PILImage.Image

    def __post_init__(self):
        image = self.image

        if not image.format:
            raise TypeError(
                "Could not read the format of the image passed to the model."
            )

        buffer = BytesIO()
        image.save(buffer, format=image.format)
        self.image_str = base64.b64encode(buffer.getvalue()).decode("utf-8")
        self.image_format = f"image/{image.format.lower()}"

Video dataclass

Contains a video that can be passed to a multimodal model.

Provide one or several instances of this class along with a text prompt in a list as the model_input argument to a model that supports video processing.

Parameters:

Name Type Description Default
video Any

The video to use in the text generation.

 required
Source code in outlines/inputs.py 
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
@dataclass
class Video:
    """Contains a video that can be passed to a multimodal model.

    Provide one or several instances of this class along with a text prompt
    in a list as the `model_input` argument to a model that supports video
    processing.

    Parameters
    ----------
    video
        The video to use in the text generation.

    """
    video: Any