mirascope.core.base.message_param¶

`BaseMessageParam`¶

Bases: BaseModel

A base class for message parameters.

Usage Documentation

Attributes:

Name	Type	Description
`role`	`str`	The role of the message (e.g. "system", "user", "assistant", "tool")
`content`	`str \| Sequence[TextPart \| ImagePart \| ImageURLPart \| AudioPart \| AudioURLPart \| CacheControlPart \| DocumentPart \| ToolCallPart \| ToolResultPart]`	The content of the message
`tool_name`	`str \| Sequence[TextPart \| ImagePart \| ImageURLPart \| AudioPart \| AudioURLPart \| CacheControlPart \| DocumentPart \| ToolCallPart \| ToolResultPart]`	The name of the tool, if any

Bases: BaseModel

A content part for text.

Attributes:

Name	Type	Description
`type`	`Literal['text']`	Always "text"
`text`	`str`	The text content

Bases: BaseModel

A content part for images.

Attributes:

Name	Type	Description
`type`	`Literal['image']`	Always "image"
`media_type`	`str`	The media type (e.g. image/jpeg)
`image`	`bytes`	The raw image bytes
`detail`	`str \| None`	(Optional) The detail to use for the image (supported by OpenAI)

Bases: BaseModel

A content part for audio.

Attributes:

Name	Type	Description
`type`	`Literal['audio']`	Always "audio"
`media_type`	`str`	The media type (e.g. audio/wav)
`audio`	`bytes \| str`	The raw audio bytes or base64 encoded audio data