mirascope.core.openai.call_response
Module call_response
This module contains the OpenAICallResponse class.
Usage
Class ChatCompletionAudio
Class OpenAICallResponse
A convenience wrapper around the OpenAI ChatCompletion response.
When calling the OpenAI API using a function decorated with openai_call, the
response will be an OpenAICallResponse instance with properties that allow for
more convenience access to commonly used attributes.
Example:
from mirascope.core import prompt_template
from mirascope.core.openai import openai_call
@openai_call("gpt-4o")
def recommend_book(genre: str) -> str:
return f"Recommend a {genre} book"
response = recommend_book("fantasy") # response is an `OpenAICallResponse` instance
print(response.content)Bases:
BaseCallResponse[ChatCompletion, OpenAITool, ChatCompletionToolParam, OpenAIDynamicConfig, ChatCompletionMessageParam, OpenAICallParams, ChatCompletionUserMessageParam, OpenAIMessageParamConverter]Attributes
| Name | Type | Description |
|---|---|---|
| response | SkipValidation[ChatCompletion] | - |
| content | str | Returns the content of the chat completion for the 0th choice. |
| finish_reasons | list[str] | Returns the finish reasons of the response. |
| model | str | Returns the name of the response model. |
| id | str | Returns the id of the response. |
| usage | CompletionUsage | None | Returns the usage of the chat completion. |
| input_tokens | int | None | Returns the number of input tokens. |
| cached_tokens | int | None | Returns the number of cached tokens. |
| output_tokens | int | None | Returns the number of output tokens. |
| message_param | SerializeAsAny[ChatCompletionAssistantMessageParam] | Returns the assistants's response as a message parameter. |
| tools | list[OpenAITool] | None | Returns any available tool calls as their `OpenAITool` definition. |
| tool | OpenAITool | None | Returns the 0th tool for the 0th choice message. |
| audio | bytes | None | Returns the audio data of the response. |
| audio_transcript | str | None | Returns the transcript of the audio content. |
| common_finish_reasons | list[FinishReason] | None | Provider-agnostic finish reasons. |
| common_message_param | BaseMessageParam | - |
| common_user_message_param | BaseMessageParam | None | - |
| cost_metadata | CostMetadata | - |
Function tool_message_params
Returns the tool message parameters for tool call results.
Parameters
| Name | Type | Description |
|---|---|---|
| cls | Any | - |
| tools_and_outputs | list[tuple[OpenAITool, str]] | The list of tools and their outputs from which the tool message parameters should be constructed. |
Returns
| Type | Description |
|---|---|
| list[ChatCompletionToolMessageParam] | The list of constructed `ChatCompletionToolMessageParam` parameters. |