Skip to content

openai.calls

A module for calling OpenAI's Chat Completion models.

OpenAICall

Bases: BaseCall[OpenAICallResponse, OpenAICallResponseChunk, OpenAITool]

A base class for calling OpenAI's Chat Completion models.

Example:

from mirascope.openai import OpenAICall


class BookRecommender(OpenAICall):
    prompt_template = "Please recommend a {genre} book"

    genre: str

response = BookRecommender(genre="fantasy").call()
print(response.content)
#> There are many great books to read, it ultimately depends...
Source code in mirascope/openai/calls.py 
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
class OpenAICall(BaseCall[OpenAICallResponse, OpenAICallResponseChunk, OpenAITool]):
    """A base class for calling OpenAI's Chat Completion models.

    Example:

    ```python
    from mirascope.openai import OpenAICall


    class BookRecommender(OpenAICall):
        prompt_template = "Please recommend a {genre} book"

        genre: str

    response = BookRecommender(genre="fantasy").call()
    print(response.content)
    #> There are many great books to read, it ultimately depends...
    ```
    """

    call_params: ClassVar[OpenAICallParams] = OpenAICallParams()

    def messages(self) -> list[ChatCompletionMessageParam]:
        """Returns the template as a formatted list of messages."""
        message_type_by_role = {
            MessageRole.SYSTEM: ChatCompletionSystemMessageParam,
            MessageRole.USER: ChatCompletionUserMessageParam,
            MessageRole.ASSISTANT: ChatCompletionAssistantMessageParam,
            MessageRole.TOOL: ChatCompletionToolMessageParam,
        }
        return [
            message_type_by_role[MessageRole(message["role"])](
                role=message["role"], content=message["content"]
            )
            for message in self._parse_messages(list(message_type_by_role.keys()))
        ]

    @retry
    def call(
        self, retries: Union[int, Retrying] = 1, **kwargs: Any
    ) -> OpenAICallResponse:
        """Makes a call to the model using this `OpenAICall` instance.

        Args:
            retries: An integer for the number of times to retry the call or
                a `tenacity.Retrying` instance.
            **kwargs: Additional keyword arguments parameters to pass to the call. These
                will override any existing arguments in `call_params`.

        Returns:
            A `OpenAICallResponse` instance.

        Raises:
            OpenAIError: raises any OpenAI errors, see:
                https://platform.openai.com/docs/guides/error-codes/api-errors
        """
        kwargs, tool_types = self._setup_openai_kwargs(kwargs)
        client = OpenAI(api_key=self.api_key, base_url=self.base_url)
        if self.call_params.wrapper is not None:
            client = self.call_params.wrapper(client)
        if self.call_params.logfire:
            self.call_params.logfire(client)  # pragma: no cover
        messages = self._update_messages_if_json(self.messages(), tool_types)
        start_time = datetime.datetime.now().timestamp() * 1000
        completion = client.chat.completions.create(
            messages=messages,
            stream=False,
            **kwargs,
        )
        return OpenAICallResponse(
            response=completion,
            tool_types=tool_types,
            start_time=start_time,
            end_time=datetime.datetime.now().timestamp() * 1000,
            cost=openai_api_calculate_cost(completion.usage, completion.model),
            response_format=self.call_params.response_format,
        )

    @retry
    async def call_async(
        self, retries: Union[int, AsyncRetrying] = 1, **kwargs: Any
    ) -> OpenAICallResponse:
        """Makes an asynchronous call to the model using this `OpenAICall`.

        Args:
            retries: An integer for the number of times to retry the call or
                a `tenacity.AsyncRetrying` instance.
            **kwargs: Additional keyword arguments parameters to pass to the call. These
                will override any existing arguments in `call_params`.

        Returns:
            An `OpenAICallResponse` instance.

        Raises:
            OpenAIError: raises any OpenAI errors, see:
                https://platform.openai.com/docs/guides/error-codes/api-errors
        """
        kwargs, tool_types = self._setup_openai_kwargs(kwargs)
        client = AsyncOpenAI(api_key=self.api_key, base_url=self.base_url)
        if self.call_params.wrapper_async is not None:
            client = self.call_params.wrapper_async(client)
        if self.call_params.logfire:
            self.call_params.logfire(client)  # pragma: no cover
        messages = self._update_messages_if_json(self.messages(), tool_types)
        start_time = datetime.datetime.now().timestamp() * 1000
        completion = await client.chat.completions.create(
            messages=messages,
            stream=False,
            **kwargs,
        )
        return OpenAICallResponse(
            response=completion,
            tool_types=tool_types,
            start_time=start_time,
            end_time=datetime.datetime.now().timestamp() * 1000,
            cost=openai_api_calculate_cost(completion.usage, completion.model),
            response_format=self.call_params.response_format,
        )

    @retry
    def stream(
        self, retries: Union[int, Retrying] = 1, **kwargs: Any
    ) -> Generator[OpenAICallResponseChunk, None, None]:
        """Streams the response for a call using this `OpenAICall`.

        Args:
            retries: An integer for the number of times to retry the call or
                a `tenacity.Retrying` instance.
            **kwargs: Additional keyword arguments parameters to pass to the call. These
                will override any existing arguments in `call_params`.

        Yields:
            A `OpenAICallResponseChunk` for each chunk of the response.

        Raises:
            OpenAIError: raises any OpenAI errors, see:
                https://platform.openai.com/docs/guides/error-codes/api-errors
        """
        kwargs, tool_types = self._setup_openai_kwargs(kwargs)
        client = OpenAI(api_key=self.api_key, base_url=self.base_url)
        if self.call_params.wrapper is not None:
            client = self.call_params.wrapper(client)
        if self.call_params.logfire:
            self.call_params.logfire(client)  # pragma: no cover
        messages = self._update_messages_if_json(self.messages(), tool_types)
        stream = client.chat.completions.create(
            messages=messages,
            stream=True,
            **kwargs,
        )
        for chunk in stream:
            yield OpenAICallResponseChunk(
                chunk=chunk,
                tool_types=tool_types,
                response_format=self.call_params.response_format,
            )

    @retry
    async def stream_async(
        self, retries: Union[int, AsyncRetrying] = 1, **kwargs: Any
    ) -> AsyncGenerator[OpenAICallResponseChunk, None]:
        """Streams the response for an asynchronous call using this `OpenAICall`.

        Args:
            retries: An integer for the number of times to retry the call or
                a `tenacity.AsyncRetrying` instance.
            **kwargs: Additional keyword arguments parameters to pass to the call. These
                will override any existing arguments in `call_params`.

        Yields:
            A `OpenAICallResponseChunk` for each chunk of the response.

        Raises:
            OpenAIError: raises any OpenAI errors, see:
                https://platform.openai.com/docs/guides/error-codes/api-errors
        """
        kwargs, tool_types = self._setup_openai_kwargs(kwargs)
        client = AsyncOpenAI(api_key=self.api_key, base_url=self.base_url)
        if self.call_params.wrapper_async is not None:
            client = self.call_params.wrapper_async(client)
        if self.call_params.logfire:
            self.call_params.logfire(client)  # pragma: no cover
        messages = self._update_messages_if_json(self.messages(), tool_types)
        stream = await client.chat.completions.create(
            messages=messages,
            stream=True,
            **kwargs,
        )
        async for chunk in stream:
            yield OpenAICallResponseChunk(
                chunk=chunk,
                tool_types=tool_types,
                response_format=self.call_params.response_format,
            )

    ############################## PRIVATE METHODS ###################################

    def _setup_openai_kwargs(
        self,
        kwargs: dict[str, Any],
    ) -> tuple[
        dict[str, Any],
        Optional[list[Type[OpenAITool]]],
    ]:
        """Overrides the `BaseCall._setup` for Anthropic specific setup."""
        kwargs, tool_types = self._setup(kwargs, OpenAITool)
        if (
            self.call_params.response_format == ResponseFormat(type="json_object")
            and tool_types
        ):
            kwargs.pop("tools")
        return kwargs, tool_types

    def _update_messages_if_json(
        self,
        messages: list[ChatCompletionMessageParam],
        tool_types: Optional[list[type[OpenAITool]]],
    ) -> list[ChatCompletionMessageParam]:
        if (
            self.call_params.response_format == ResponseFormat(type="json_object")
            and tool_types
        ):
            messages.append(
                ChatCompletionUserMessageParam(
                    role="user", content=_json_mode_content(tool_type=tool_types[0])
                )
            )
        return messages

call(retries=1, **kwargs)

Makes a call to the model using this OpenAICall instance.

Parameters:

Name Type Description Default
retries Union[int, Retrying]

An integer for the number of times to retry the call or a tenacity.Retrying instance.

 1
**kwargs Any

Additional keyword arguments parameters to pass to the call. These will override any existing arguments in call_params.

 {}

Returns:

Type Description
OpenAICallResponse

A OpenAICallResponse instance.

Raises:

Type Description
OpenAIError

raises any OpenAI errors, see: https://platform.openai.com/docs/guides/error-codes/api-errors
Source code in mirascope/openai/calls.py 
 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
@retry
def call(
    self, retries: Union[int, Retrying] = 1, **kwargs: Any
) -> OpenAICallResponse:
    """Makes a call to the model using this `OpenAICall` instance.

    Args:
        retries: An integer for the number of times to retry the call or
            a `tenacity.Retrying` instance.
        **kwargs: Additional keyword arguments parameters to pass to the call. These
            will override any existing arguments in `call_params`.

    Returns:
        A `OpenAICallResponse` instance.

    Raises:
        OpenAIError: raises any OpenAI errors, see:
            https://platform.openai.com/docs/guides/error-codes/api-errors
    """
    kwargs, tool_types = self._setup_openai_kwargs(kwargs)
    client = OpenAI(api_key=self.api_key, base_url=self.base_url)
    if self.call_params.wrapper is not None:
        client = self.call_params.wrapper(client)
    if self.call_params.logfire:
        self.call_params.logfire(client)  # pragma: no cover
    messages = self._update_messages_if_json(self.messages(), tool_types)
    start_time = datetime.datetime.now().timestamp() * 1000
    completion = client.chat.completions.create(
        messages=messages,
        stream=False,
        **kwargs,
    )
    return OpenAICallResponse(
        response=completion,
        tool_types=tool_types,
        start_time=start_time,
        end_time=datetime.datetime.now().timestamp() * 1000,
        cost=openai_api_calculate_cost(completion.usage, completion.model),
        response_format=self.call_params.response_format,
    )

call_async(retries=1, **kwargs) async

Makes an asynchronous call to the model using this OpenAICall.

Parameters:

Name Type Description Default
retries Union[int, AsyncRetrying]

An integer for the number of times to retry the call or a tenacity.AsyncRetrying instance.

 1
**kwargs Any

Additional keyword arguments parameters to pass to the call. These will override any existing arguments in call_params.

 {}

Returns:

Type Description
OpenAICallResponse

An OpenAICallResponse instance.

Raises:

Type Description
OpenAIError

raises any OpenAI errors, see: https://platform.openai.com/docs/guides/error-codes/api-errors
Source code in mirascope/openai/calls.py 
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
@retry
async def call_async(
    self, retries: Union[int, AsyncRetrying] = 1, **kwargs: Any
) -> OpenAICallResponse:
    """Makes an asynchronous call to the model using this `OpenAICall`.

    Args:
        retries: An integer for the number of times to retry the call or
            a `tenacity.AsyncRetrying` instance.
        **kwargs: Additional keyword arguments parameters to pass to the call. These
            will override any existing arguments in `call_params`.

    Returns:
        An `OpenAICallResponse` instance.

    Raises:
        OpenAIError: raises any OpenAI errors, see:
            https://platform.openai.com/docs/guides/error-codes/api-errors
    """
    kwargs, tool_types = self._setup_openai_kwargs(kwargs)
    client = AsyncOpenAI(api_key=self.api_key, base_url=self.base_url)
    if self.call_params.wrapper_async is not None:
        client = self.call_params.wrapper_async(client)
    if self.call_params.logfire:
        self.call_params.logfire(client)  # pragma: no cover
    messages = self._update_messages_if_json(self.messages(), tool_types)
    start_time = datetime.datetime.now().timestamp() * 1000
    completion = await client.chat.completions.create(
        messages=messages,
        stream=False,
        **kwargs,
    )
    return OpenAICallResponse(
        response=completion,
        tool_types=tool_types,
        start_time=start_time,
        end_time=datetime.datetime.now().timestamp() * 1000,
        cost=openai_api_calculate_cost(completion.usage, completion.model),
        response_format=self.call_params.response_format,
    )

messages()

Returns the template as a formatted list of messages.

Source code in mirascope/openai/calls.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
def messages(self) -> list[ChatCompletionMessageParam]:
    """Returns the template as a formatted list of messages."""
    message_type_by_role = {
        MessageRole.SYSTEM: ChatCompletionSystemMessageParam,
        MessageRole.USER: ChatCompletionUserMessageParam,
        MessageRole.ASSISTANT: ChatCompletionAssistantMessageParam,
        MessageRole.TOOL: ChatCompletionToolMessageParam,
    }
    return [
        message_type_by_role[MessageRole(message["role"])](
            role=message["role"], content=message["content"]
        )
        for message in self._parse_messages(list(message_type_by_role.keys()))
    ]

stream(retries=1, **kwargs)

Streams the response for a call using this OpenAICall.

Parameters:

Name Type Description Default
retries Union[int, Retrying]

An integer for the number of times to retry the call or a tenacity.Retrying instance.

 1
**kwargs Any

Additional keyword arguments parameters to pass to the call. These will override any existing arguments in call_params.

 {}

Yields:

Type Description
OpenAICallResponseChunk

A OpenAICallResponseChunk for each chunk of the response.

Raises:

Type Description
OpenAIError

raises any OpenAI errors, see: https://platform.openai.com/docs/guides/error-codes/api-errors
Source code in mirascope/openai/calls.py 
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
@retry
def stream(
    self, retries: Union[int, Retrying] = 1, **kwargs: Any
) -> Generator[OpenAICallResponseChunk, None, None]:
    """Streams the response for a call using this `OpenAICall`.

    Args:
        retries: An integer for the number of times to retry the call or
            a `tenacity.Retrying` instance.
        **kwargs: Additional keyword arguments parameters to pass to the call. These
            will override any existing arguments in `call_params`.

    Yields:
        A `OpenAICallResponseChunk` for each chunk of the response.

    Raises:
        OpenAIError: raises any OpenAI errors, see:
            https://platform.openai.com/docs/guides/error-codes/api-errors
    """
    kwargs, tool_types = self._setup_openai_kwargs(kwargs)
    client = OpenAI(api_key=self.api_key, base_url=self.base_url)
    if self.call_params.wrapper is not None:
        client = self.call_params.wrapper(client)
    if self.call_params.logfire:
        self.call_params.logfire(client)  # pragma: no cover
    messages = self._update_messages_if_json(self.messages(), tool_types)
    stream = client.chat.completions.create(
        messages=messages,
        stream=True,
        **kwargs,
    )
    for chunk in stream:
        yield OpenAICallResponseChunk(
            chunk=chunk,
            tool_types=tool_types,
            response_format=self.call_params.response_format,
        )

stream_async(retries=1, **kwargs) async

Streams the response for an asynchronous call using this OpenAICall.

Parameters:

Name Type Description Default
retries Union[int, AsyncRetrying]

An integer for the number of times to retry the call or a tenacity.AsyncRetrying instance.

 1
**kwargs Any

Additional keyword arguments parameters to pass to the call. These will override any existing arguments in call_params.

 {}

Yields:

Type Description
AsyncGenerator[OpenAICallResponseChunk, None]

A OpenAICallResponseChunk for each chunk of the response.

Raises:

Type Description
OpenAIError

raises any OpenAI errors, see: https://platform.openai.com/docs/guides/error-codes/api-errors
Source code in mirascope/openai/calls.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
@retry
async def stream_async(
    self, retries: Union[int, AsyncRetrying] = 1, **kwargs: Any
) -> AsyncGenerator[OpenAICallResponseChunk, None]:
    """Streams the response for an asynchronous call using this `OpenAICall`.

    Args:
        retries: An integer for the number of times to retry the call or
            a `tenacity.AsyncRetrying` instance.
        **kwargs: Additional keyword arguments parameters to pass to the call. These
            will override any existing arguments in `call_params`.

    Yields:
        A `OpenAICallResponseChunk` for each chunk of the response.

    Raises:
        OpenAIError: raises any OpenAI errors, see:
            https://platform.openai.com/docs/guides/error-codes/api-errors
    """
    kwargs, tool_types = self._setup_openai_kwargs(kwargs)
    client = AsyncOpenAI(api_key=self.api_key, base_url=self.base_url)
    if self.call_params.wrapper_async is not None:
        client = self.call_params.wrapper_async(client)
    if self.call_params.logfire:
        self.call_params.logfire(client)  # pragma: no cover
    messages = self._update_messages_if_json(self.messages(), tool_types)
    stream = await client.chat.completions.create(
        messages=messages,
        stream=True,
        **kwargs,
    )
    async for chunk in stream:
        yield OpenAICallResponseChunk(
            chunk=chunk,
            tool_types=tool_types,
            response_format=self.call_params.response_format,
        )