from dataclasses import dataclass
from typing import List, Literal, Optional, Union
from pydantic import BaseModel, ConfigDict, Field
from typing_extensions import Annotated
from ...function_call import FunctionCall
from ..image import Image
[docs]
class SystemMessage(BaseModel):
"""System message contains instructions for the model coming from the developer.
.. note::
Open AI is moving away from using 'system' role in favor of 'developer' role.
See `Model Spec <https://cdn.openai.com/spec/model-spec-2024-05-08.html#definitions>`_ for more details.
However, the 'system' role is still allowed in their API and will be automatically converted to 'developer' role
on the server side.
So, you can use `SystemMessage` for developer messages.
"""
content: str
"""The content of the message."""
type: Literal["SystemMessage"] = "SystemMessage"
[docs]
class UserMessage(BaseModel):
"""User message contains input from end users, or a catch-all for data provided to the model."""
content: Union[str, List[Union[str, Image]]]
"""The content of the message."""
source: str
"""The name of the agent that sent this message."""
type: Literal["UserMessage"] = "UserMessage"
[docs]
class AssistantMessage(BaseModel):
"""Assistant message are sampled from the language model."""
content: Union[str, List[FunctionCall]]
"""The content of the message."""
thought: str | None = None
"""The reasoning text for the completion if available. Used for reasoning model and additional text content besides function calls."""
source: str
"""The name of the agent that sent this message."""
type: Literal["AssistantMessage"] = "AssistantMessage"
class VercelMessagePart(BaseModel):
"""Vercel message part is a part of a vercel message."""
type: str
"""The type of the part."""
model_config = ConfigDict(extra="allow") # Allow unknown fields
[docs]
class VercelMessage(BaseModel):
"""Vercel message is a message supported by vercel ai sdk."""
role: str
"""The role of the message."""
content: str
"""The content of the message."""
parts: List[VercelMessagePart]
"""The parts of the message."""
type: Literal["VercelMessage"] = "VercelMessage"
[docs]
class FunctionExecutionResult(BaseModel):
"""Function execution result contains the output of a function call."""
content: str
"""The output of the function call."""
name: str
"""(New in v0.4.8) The name of the function that was called."""
call_id: str
"""The ID of the function call. Note this ID may be empty for some models."""
is_error: bool | None = None
"""Whether the function call resulted in an error."""
[docs]
class FunctionExecutionResultMessage(BaseModel):
"""Function execution result message contains the output of multiple function calls."""
content: List[FunctionExecutionResult]
type: Literal["FunctionExecutionResultMessage"] = "FunctionExecutionResultMessage"
LLMMessage = Annotated[
Union[SystemMessage, UserMessage, AssistantMessage, FunctionExecutionResultMessage, VercelMessage], Field(discriminator="type")
]
[docs]
@dataclass
class RequestUsage:
prompt_tokens: int
completion_tokens: int
FinishReasons = Literal["stop", "length", "function_calls", "content_filter", "unknown"]
[docs]
@dataclass
class TopLogprob:
logprob: float
bytes: Optional[List[int]] = None
[docs]
class ChatCompletionTokenLogprob(BaseModel):
token: str
logprob: float
top_logprobs: Optional[List[TopLogprob] | None] = None
bytes: Optional[List[int]] = None
[docs]
class CreateResult(BaseModel):
"""Create result contains the output of a model completion."""
finish_reason: FinishReasons
"""The reason the model finished generating the completion."""
content: Union[str, List[FunctionCall]]
"""The output of the model completion."""
usage: RequestUsage
"""The usage of tokens in the prompt and completion."""
cached: bool
"""Whether the completion was generated from a cached response."""
logprobs: Optional[List[ChatCompletionTokenLogprob] | None] = None
"""The logprobs of the tokens in the completion."""
thought: Optional[str] = None
"""The reasoning text for the completion if available. Used for reasoning models
and additional text content besides function calls."""